Skip to content

Commit ea9d6e4

Browse files
M5oulOfek Lev
andauthored
Full command path headers: add note regarding md extensions order (#88)
Co-authored-by: Ofek Lev <ofekmeister@gmail.com>
1 parent d9dd69d commit ea9d6e4

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,8 @@ markdown_extensions:
110110
- mkdocs-click
111111
```
112112

113+
***IMPORTANT:*** `attr_list` must come before `mkdocs-click` for this to work.
114+
113115
`mkdocs-click` will then output the full command path in headers (e.g. `## cli build all`) and permalinks (e.g. `#cli-build-all`).
114116

115117
Note that the table of content (TOC) will still use the command name: the TOC is naturally hierarchal, so full command paths would be redundant. (This exception is why the `attr_list` extension is required.)

0 commit comments

Comments
 (0)