Skip to content

Commit 4b1d48d

Browse files
committed
Update badges docs
1 parent a47ab99 commit 4b1d48d

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

docs/badges.rst

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,30 @@ Here are a few examples:
1919
You can see it in action in the `Read the Docs README`_.
2020
They will link back to your project's documentation page on Read the Docs.
2121

22+
Style
23+
-----
24+
25+
Now you can pass the ``style`` GET argument,
26+
to get custom styled badges same as you would for shields.io.
27+
If no argument is passed, ``flat`` is used as default.
28+
29+
STYLE | BADGE
30+
------------ | -------------
31+
flat | ![Flat Badge](https://readthedocs.org/projects/pip/badge/?version=latest&style=flat)
32+
flat-square | ![Flat-Square Badge](https://readthedocs.org/projects/pip/badge/?version=latest&style=flat-square)
33+
for-the-badge | ![ Badge](https://readthedocs.org/projects/pip/badge/?version=latest&style=for-the-badge)
34+
plastic | ![Plastic Badge](https://readthedocs.org/projects/pip/badge/?version=latest&style=plastic)
35+
social | ![Social Badge](https://readthedocs.org/projects/pip/badge/?version=latest&style=social)
36+
37+
2238
Project Pages
2339
-------------
2440

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

29-
https://readthedocs.org/projects/pip/badge/?version=latest
45+
https://readthedocs.org/projects/pip/badge/?version=latest&style=plastic
3046

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

0 commit comments

Comments
 (0)