_klipper3d: Add additional comments to mkdocs.yml
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
parent
c3ab8fee90
commit
b837a344c1
|
@ -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: '../'
|
docs_dir: '../'
|
||||||
site_dir: '../../site/'
|
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:
|
theme:
|
||||||
name: material
|
name: material
|
||||||
palette:
|
palette:
|
||||||
|
@ -19,8 +47,6 @@ theme:
|
||||||
toggle:
|
toggle:
|
||||||
icon: material/lightbulb-outline
|
icon: material/lightbulb-outline
|
||||||
name: Switch to light mode
|
name: Switch to light mode
|
||||||
# primary: white
|
|
||||||
# accent: blue
|
|
||||||
logo: img/klipper.svg
|
logo: img/klipper.svg
|
||||||
favicon: img/favicon.ico
|
favicon: img/favicon.ico
|
||||||
icon:
|
icon:
|
||||||
|
@ -36,36 +62,15 @@ theme:
|
||||||
- search.share
|
- search.share
|
||||||
extra_css:
|
extra_css:
|
||||||
- _klipper3d/css/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:
|
extra:
|
||||||
analytics:
|
|
||||||
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#site-search-tracking
|
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/#site-search-tracking
|
||||||
|
analytics:
|
||||||
provider: google
|
provider: google
|
||||||
property: UA-138371409-1
|
property: UA-138371409-1
|
||||||
# version:
|
|
||||||
# provider: mike
|
# Navigation hierarchy (this should mimic the layout of Overview.md)
|
||||||
nav:
|
nav:
|
||||||
- Overview:
|
- Overview:
|
||||||
- Overview.md
|
- Overview.md
|
||||||
|
|
Loading…
Reference in New Issue