diff options
| author | Kevin O'Connor <kevin@koconnor.net> | 2021-08-02 14:05:25 -0400 |
|---|---|---|
| committer | Kevin O'Connor <kevin@koconnor.net> | 2021-08-02 14:05:25 -0400 |
| commit | b837a344c1aaf1634dd09d0fd537f7104b64d303 (patch) | |
| tree | e38b1d4efd542a5bab2a9b807c7b13644a233dcb /docs | |
| parent | c3ab8fee90c155dc8005343f3ffeaed3eeed4d6d (diff) | |
| download | kutter-b837a344c1aaf1634dd09d0fd537f7104b64d303.tar.gz kutter-b837a344c1aaf1634dd09d0fd537f7104b64d303.tar.xz kutter-b837a344c1aaf1634dd09d0fd537f7104b64d303.zip | |
_klipper3d: Add additional comments to mkdocs.yml
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/_klipper3d/mkdocs.yml | 63 |
1 files changed, 34 insertions, 29 deletions
diff --git a/docs/_klipper3d/mkdocs.yml b/docs/_klipper3d/mkdocs.yml index 524c0577..0333b26f 100644 --- a/docs/_klipper3d/mkdocs.yml +++ b/docs/_klipper3d/mkdocs.yml @@ -1,7 +1,35 @@ -# This is the main configuration file for mkdocs +# Main configuration file for mkdocs generation of klipper3d.org website + +# Site and directory configuration +site_name: Klipper documentation +repo_url: https://github.com/KevinOConnor/klipper +repo_name: KevinOConnor/klipper +edit_uri: blob/master/docs/ +use_directory_urls: False docs_dir: '../' site_dir: '../../site/' -site_name: Klipper documentation + +# Markdown document translation settings +markdown_extensions: + - toc: + permalink: True + toc_depth: 6 + #- pymdownx.snippets + - attr_list + - mdx_partial_gfm + - mdx_truly_sane_lists + - mdx_breakless_lists +plugins: + - search + - section-index + - mkdocs-simple-hooks: + hooks: + on_page_markdown: "docs._klipper3d.mkdocs_hooks:transform" + - exclude: + glob: + - README.md + +# Website layout configuration (using mkdocs-material theme) theme: name: material palette: @@ -19,8 +47,6 @@ theme: toggle: icon: material/lightbulb-outline name: Switch to light mode - # primary: white - # accent: blue logo: img/klipper.svg favicon: img/favicon.ico icon: @@ -36,36 +62,15 @@ theme: - search.share extra_css: - _klipper3d/css/extra.css -use_directory_urls: False -repo_url: https://github.com/KevinOConnor/klipper -repo_name: KevinOConnor/klipper -edit_uri: blob/master/docs/ -plugins: - - search - - section-index - - mkdocs-simple-hooks: - hooks: - on_page_markdown: "docs._klipper3d.mkdocs_hooks:transform" - - exclude: - glob: - - README.md -markdown_extensions: - - toc: - permalink: True - toc_depth: 6 - #- pymdownx.snippets - - attr_list - - mdx_partial_gfm - - mdx_truly_sane_lists - - mdx_breakless_lists +# Site usage statistics extra: - analytics: # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#site-search-tracking + analytics: provider: google property: UA-138371409-1 - # version: - # provider: mike + +# Navigation hierarchy (this should mimic the layout of Overview.md) nav: - Overview: - Overview.md |