You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/learn/book/contributing/docs/_index.md
+8-13Lines changed: 8 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -30,23 +30,18 @@ A local server should start and you should be able to access a local version of
30
30
31
31
### Rust API Doc Syntax
32
32
33
-
We made an extension to the markdown syntax that makes linking to Rust API docs nicer. It also gives the links special formatting. Here are some examples:
33
+
We made an extension to the markdown syntax that makes linking to Rust API docs nicer. It also gives the links special formatting.
34
34
35
-
* Full Type Path: {{rust_type(type="struct" crate="std", mod="collections", name="HashMap", show_mod=true)}}
35
+
You can link to both Rust types and Rust modules with these shortcodes as shown below:
- `show_crate`: shows the originating crate in the path
43
+
- `show_mod`: shows the originating module in the path
44
+
- `plural`: adds an "s" at the end of the linked type
50
45
51
46
Modules from {{rust_mod(crate="std")}} will link to [https://doc.rust-lang.org](https://doc.rust-lang.org/std/index.html). Other modules (like {{rust_mod(crate="bevy_render" mod="render_graph")}} ) will link to [https://docs.rs](https://docs.rs).
0 commit comments