Skip to content

configuration.md

Latest commit

 

History

History
84 lines (64 loc) · 1.6 KB

configuration.md

File metadata and controls

84 lines (64 loc) · 1.6 KB

Configuration

Site navigation and other configuration is defined in a mkdocs.toml file.

[mkdocs]
nav = [
    {title="Introduction", path="index.md"},
    {title="Writing Markdown", path="writing.md"},
    {title="Site Navigation", path="navigation.md"},
    {title="HTML Styling", path="styling.md"}
]

Navigation can include subsections...

[mkdocs]
nav = [
    {title="Introduction", path="README.md"},
    {title="Guides", children=[
        {title="Writing Markdown", path="writing.md"},
        {title="Site Navigation", path="navigation.md"},
        {title="HTML Styling", path="styling.md"}
    ]}
]

Loaders

Loaders determine where documentation resources are collected from.

loaders = [
    {type="directory", dir="docs"},
    {type="package", pkg="mkdocs.theme"}
]

Customise this to load a different theme, from a ZIP archive...

loaders = [
    {type="directory", dir="docs"},
    {type="url", url="https://www.example.com/theme.zip"}
]

Or from a GitHub repo...

loaders = [
    {type="directory", dir="docs"},
    {type="github", url="mkdocs/default"}
]