Skip to content

Commit

Permalink
Add tidelift_url customization option
Browse files Browse the repository at this point in the history
Allows adding a Tidelift section to the sidebar
by setting the `tidelift_url`theme option.

**Screenshot**

![screenshot](https://user-images.githubusercontent.com/2379650/45132398-cf6efe00-b15e-11e8-887b-6bf8e41e2f87.png)
  • Loading branch information
sloria committed Sep 6, 2018
1 parent 5f24967 commit 759549d
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 0 deletions.
8 changes: 8 additions & 0 deletions alabaster/donate.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,11 @@ <h3>Donate</h3>
src="//gttp.co/v1.js"></script>
</p>
{% endif %}

{% if theme_tidelift_url %}
<h3>Professional support</h3>
<p>
Professionally-supported {{ project }} is available with the
<a href="{{ theme_tidelift_url }}">Tidelift Subscription</a>.
</p>
{% endif %}
1 change: 1 addition & 0 deletions alabaster/theme.conf
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ travis_button = false
codecov_button = false
gratipay_user =
gittip_user =
tidelift_url =
analytics_id =
touch_icon =
canonical_url =
Expand Down
2 changes: 2 additions & 0 deletions docs/customization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,8 @@ Variables and feature toggles
string - used to display a `Travis-CI <https://travis-ci.org>`_ build status
button in the sidebar. If ``true``, uses your ``github_(user|repo)``
settings.
* ``tidelift_url``: Set your `Tidelift <https://tidelift.com/>`_ project
URL if you want a "Professional support" section in your sidebar.
* ``codecov_button``: ``true``, ``false`` or a Github-style ``"account/repo"``
string - used to display a `Codecov <https://codecov.io>`_ build status
button in the sidebar. If ``true``, uses your ``github_(user|repo)``
Expand Down

0 comments on commit 759549d

Please sign in to comment.