We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent c3ede70 commit ca2f8daCopy full SHA for ca2f8da
src/doc/rustdoc/src/how-to-write-documentation.md
@@ -267,6 +267,22 @@ you can wrap it like this:
267
/// more documentation
268
```
269
270
+Please note that if you want to put markdown in the HTML tag and for it to
271
+be interpreted as such, you need to have an empty line between the HTML tags
272
+and your markdown content. For example if you want to use a link:
273
+
274
+```md
275
+/// documentation
276
+///
277
+/// <div class="warning">
278
279
+/// Go to [this link](https://rust-lang.org)!
280
281
+/// </div>
282
283
+/// more documentation
284
+```
285
286
[`backtrace`]: https://docs.rs/backtrace/0.3.50/backtrace/
287
[commonmark markdown specification]: https://commonmark.org/
288
[commonmark quick reference]: https://commonmark.org/help/
0 commit comments