File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -111,6 +111,24 @@ Every type in action — this is what the five markers look like in the built th
111111> [ !CAUTION]
112112> Advises about risks or negative outcomes of certain actions.
113113
114+ ## Checklists
115+
116+ GitHub Flavored Markdown task lists render out of the box — ` - [x] ` for done, ` - [ ] ` for pending:
117+
118+ ``` md
119+ - [x] Install Docsmith
120+ - [ ] Write the first page
121+ - [ ] Ship it
122+ ```
123+
124+ Good use cases for checklists in documentation:
125+
126+ - ** Prerequisites** — list what readers need before starting; they can scan it at a glance.
127+ - ** Step-by-step progress** — long setup or migration guides readers return to later.
128+ - ** Release readiness** — QA and pre-launch checklists inside engineering docs.
129+ - ** Troubleshooting trees** — ordered fixes readers work through until the problem resolves.
130+ - ** Support matrices** — compact yes/no capability lists without building a table.
131+
114132## Command line
115133
116134Docsmith ships a standalone binary that builds a site without writing any PHP. After installing the package, run:
You can’t perform that action at this time.
0 commit comments