File tree Expand file tree Collapse file tree 1 file changed +21
-1
lines changed Expand file tree Collapse file tree 1 file changed +21
-1
lines changed Original file line number Diff line number Diff line change @@ -27,9 +27,29 @@ crates' documentation easily. Example of URL redirections for `clap` crate:
27
27
The crates.fyi domain will redirect to docs.rs, supporting all of the
28
28
redirects discussed above
29
29
30
+
31
+ ### Badges
32
+
33
+ You can use badges to show state of your documentation to your users.
34
+ The default badge will be pointed at the latest version of a crate.
35
+ You can use ` version ` parameter to show status of documentation for
36
+ any version you want.
37
+
38
+ Badge will display in blue if docs.rs is successfully hosting your crate
39
+ documentation, and red if building documentation failing.
40
+
41
+ Example badges for ` mio ` crate:
42
+
43
+ | URL | Badge |
44
+ | -------| -------|
45
+ | Latest version: < https://docs.rs/mio/badge.svg > | ![ mio] ( https://docs.rs/mio/badge.svg ) |
46
+ | Version 0.4.4: < https://docs.rs/mio/badge.svg?version=0.4.4 > | ![ mio] ( https://docs.rs/mio/badge.svg?version=0.4.4 ) |
47
+ | Version 0.1.0: < https://docs.rs/mio/badge.svg?version=0.1.0 > | ![ mio] ( https://docs.rs/mio/badge.svg?version=0.1.0 ) |
48
+
49
+
30
50
#### Contributors
31
51
32
- * [ Onur Aslan] ( https://github.com/onur] )
52
+ * [ Onur Aslan] ( https://github.com/onur )
33
53
* [ Corey Farwell] ( https://github.com/frewsxcv )
34
54
* [ Jon Gjengset] ( https://github.com/jonhoo )
35
55
* [ Matthew Hall] ( https://github.com/mattyhall )
You can’t perform that action at this time.
0 commit comments