We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent d51521e commit 57d2b84Copy full SHA for 57d2b84
src/doc/rustdoc/src/how-to-write-documentation.md
@@ -254,6 +254,18 @@ characters:
254
255
So, no need to manually enter those Unicode characters!
256
257
+### Adding a warning block
258
+
259
+If you want to make a "warning" stand out in the documentation, you can wrap it like this:
260
261
+```md
262
+/// documentation
263
+///
264
+/// <div class="warning">A big warning!</div>
265
266
+/// more documentation
267
+```
268
269
[`backtrace`]: https://docs.rs/backtrace/0.3.50/backtrace/
270
[commonmark markdown specification]: https://commonmark.org/
271
[commonmark quick reference]: https://commonmark.org/help/
0 commit comments