@@ -19,14 +19,30 @@ Here are a few examples:
19
19
You can see it in action in the `Read the Docs README `_.
20
20
They will link back to your project's documentation page on Read the Docs.
21
21
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 | 
32
+ flat-square | 
33
+ for-the-badge | 
34
+ plastic | 
35
+ social | 
36
+
37
+
22
38
Project Pages
23
39
-------------
24
40
25
41
You will now see badges embedded in your `project page `_.
26
42
The default badge will be pointed at the *default version * you have specified for your project.
27
43
The badge URLs look like this::
28
44
29
- https://readthedocs.org/projects/pip/badge/?version=latest
45
+ https://readthedocs.org/projects/pip/badge/?version=latest&style=plastic
30
46
31
47
You can replace the version argument with any version that you want to show a badge for.
32
48
If you click on the badge icon,
@@ -47,4 +63,4 @@ since it will stay up to date with your Read the Docs project::
47
63
.. |red | image :: https://media.readthedocs.org/static/projects/badges/failing.svg
48
64
.. |yellow | image :: https://media.readthedocs.org/static/projects/badges/unknown.svg
49
65
.. |nbsp | unicode :: 0xA0
50
- :trim:
66
+ :trim:
0 commit comments