about summary refs log tree commit diff
path: root/src/doc/rustdoc
diff options
context:
space:
mode:
authorJonas Schievink <jonasschievink@gmail.com>2021-02-06 17:01:50 +0100
committerGitHub <noreply@github.com>2021-02-06 17:01:50 +0100
commite143159e752cb39bd92db5fc4a7904805a1ecd03 (patch)
treec25e743664c8eb7cce7f0e89dec8dbe6a61f3e99 /src/doc/rustdoc
parent96e843ce6ae42e0aa519ba45e148269de347fd84 (diff)
parent9653b601b2c5ac554e6adedf98d2ac173eb61985 (diff)
downloadrust-e143159e752cb39bd92db5fc4a7904805a1ecd03.tar.gz
rust-e143159e752cb39bd92db5fc4a7904805a1ecd03.zip
Rollup merge of #81766 - jyn514:task-lists, r=GuillaumeGomez
Enable 'task list' markdown extension

Closes https://github.com/rust-lang/rust/issues/71183.
Diffstat (limited to 'src/doc/rustdoc')
-rw-r--r--src/doc/rustdoc/src/how-to-write-documentation.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/src/doc/rustdoc/src/how-to-write-documentation.md b/src/doc/rustdoc/src/how-to-write-documentation.md
index 0a7dedb25a1..9938cddc941 100644
--- a/src/doc/rustdoc/src/how-to-write-documentation.md
+++ b/src/doc/rustdoc/src/how-to-write-documentation.md
@@ -221,6 +221,25 @@ This example will render similarly to this:
 See the specification for the [GitHub Tables extension][tables] for more
 details on the exact syntax supported.
 
+### Task lists
+
+Task lists can be used as a checklist of items that have been completed.
+Example:
+
+```md
+- [x] Complete task
+- [ ] IncComplete task
+```
+
+This will render as
+
+<ul>
+    <li><input type="checkbox"></li>
+    <li><input type="checkbox" checked></li>
+</ul>
+
+See the specification for the [task list extension] for more details.
+
 [`backtrace`]: https://docs.rs/backtrace/0.3.50/backtrace/
 [commonmark markdown specification]: https://commonmark.org/
 [commonmark quick reference]: https://commonmark.org/help/
@@ -234,3 +253,4 @@ details on the exact syntax supported.
 [`std::env`]: https://doc.rust-lang.org/stable/std/env/index.html#functions
 [strikethrough]: https://github.github.com/gfm/#strikethrough-extension-
 [tables]: https://github.github.com/gfm/#tables-extension-
+[task list extension]: https://github.github.com/gfm/#task-list-items-extension-