Skip to content

📖 MkDocs

Anchors

#### Heading producing an anchor

#### Another heading {#custom-anchor-for-heading-using-attr-list}

<a id="raw-anchor"></a>

[](){#markdown-anchor-using-attr-list}

Heading producing an anchor

Another heading

Attribute Lists

[Hello, World!](#){: #someid .someclass somekey='some value' }

Hello, World!

🔗

Dependency management

docs/requirements.txt
mkdocs==1.4.3
mkdocs-material==9.1.16

pip install --requirement docs/requirements.txt

Downloadable file

[:material-launch:](assets/example.json){: .md-button }
[:material-download:](assets/example.json){: .md-button download="example.json" }

Environment variables

mkdocs.yml
plugins:
  - foo-plugin:
      enabled: !ENV [CI, GITHUB_ACTIONS, False]

🔗

Macros plugin

🔗 Declaring external YAML files

Variable Type Content
name str 'John Doe'
age int 30
city str 'New York'
is_student bool False
grades SuperDict math = 95, science = 88, english = 92
hobbies SuperList ['reading', 'hiking', 'coding']

Meta plugin

🔗 Metadata for groups of pages

Variable Type Content
name str 'John Doe'
age int 30
city str 'New York'
is_student bool False
grades dict math = 95, science = 88, english = 92
hobbies list ['reading', 'hiking', 'coding'] 
[Open :material-launch:](https://example.org){: target=_blank rel=noopener }

Open

Result box

Say hello!
echo "Hello, World!"

Hello, World!