Skip to content

๐Ÿ“– Zensical (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' }

๐Ÿ”—

Downloadable file

[:lucide-external-link:](assets/example.json){: .md-button }
[:lucide-download:](assets/example.json){: .md-button download="example.json" }

Environment variables

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

Macros extension

๐Ÿ”— Declaring external YAML files

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

Meta plugin

๐Ÿ”— Metadata for groups of pages

Variable Type Content
include_yaml dict sample = 'data/sample.yaml'
render_macros bool True
title str '๐Ÿ“– Zensical'
[Open :lucide-external-link:](https://example.org){: target=_blank rel=noopener }

Result box

Say hello!
echo "Hello, World!"
Hello, World!