Skip to content

Commit

Permalink
Update badges docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fenilgandhi committed Feb 18, 2018
1 parent a47ab99 commit 4b1d48d
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions docs/badges.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,30 @@ Here are a few examples:
You can see it in action in the `Read the Docs README`_.
They will link back to your project's documentation page on Read the Docs.

Style
-----

Now you can pass the ``style`` GET argument,
to get custom styled badges same as you would for shields.io.
If no argument is passed, ``flat`` is used as default.

STYLE | BADGE
------------ | -------------
flat | ![Flat Badge](https://readthedocs.org/projects/pip/badge/?version=latest&style=flat)
flat-square | ![Flat-Square Badge](https://readthedocs.org/projects/pip/badge/?version=latest&style=flat-square)
for-the-badge | ![ Badge](https://readthedocs.org/projects/pip/badge/?version=latest&style=for-the-badge)
plastic | ![Plastic Badge](https://readthedocs.org/projects/pip/badge/?version=latest&style=plastic)
social | ![Social Badge](https://readthedocs.org/projects/pip/badge/?version=latest&style=social)


Project Pages
-------------

You will now see badges embedded in your `project page`_.
The default badge will be pointed at the *default version* you have specified for your project.
The badge URLs look like this::

https://readthedocs.org/projects/pip/badge/?version=latest
https://readthedocs.org/projects/pip/badge/?version=latest&style=plastic

You can replace the version argument with any version that you want to show a badge for.
If you click on the badge icon,
Expand All @@ -47,4 +63,4 @@ since it will stay up to date with your Read the Docs project::
.. |red| image:: https://media.readthedocs.org/static/projects/badges/failing.svg
.. |yellow| image:: https://media.readthedocs.org/static/projects/badges/unknown.svg
.. |nbsp| unicode:: 0xA0
:trim:
:trim:

0 comments on commit 4b1d48d

Please sign in to comment.