MkDocs

A few lesser known (to me) features for better docs

Code Blocks

Detailled docs here here

code hl_lines and linenums

highlight lines in code blocks and show line numbers

[2021-08-18 08:08]

class Foo:
    this = 'is highlighted'
    this = 'as well'
    this = 'not'

via

``python hl_lines="2-3" linenums="42"
class Foo:
    this = 'is highlighted'
    this = 'as well'
    this = 'not'
``

Layout

1. Enable - meta extension
2. Add meta data like:

---
hide:
  - navigation
  - toc
---

# My Page 
(...)

Inline

keyboard modifier keys Ctrl+Alt+Del...

show nice symbols

[2021-08-18 08:08]
Simply type inline like this "now hit ++ctrl+shift++-a", rendered as "now hit Ctrl+Shift-a" (with pymdownx.keys)