alnoda-workspaces/workspaces/mkdocs-workspace/mkdocs/mkdocs.yml
2022-07-20 17:08:36 +00:00

107 lines
2.8 KiB
YAML

# ===========================================================
# NAVIGATION
# ===========================================================
nav:
- Home: README.md
- My apps: pages/my-apps.md
- About: about.md
- Docs: https://docs.alnoda.org/mkdocs-workspace/
# ===========================================================
# CONFIGURATION
# ===========================================================
site_name: MkDocs workspace
repo_url: https://github.com/bluxmit/alnoda-workspaces
site_url: https://docs.alnoda.org
edit_uri: ""
# ===========================================================
# APPEARANCE
# ===========================================================
theme:
name: 'material'
favicon: 'assets/alnoda-dark.svg'
logo: 'assets/alnoda-white.svg'
custom_dir: overrides
font:
text: Lexend
icon:
repo: fontawesome/brands/github
features:
- search.suggest
palette:
- scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
primary: deep purple
accent: deep orange
- scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
primary: deep purple
accent: lime
extra:
# Link to open when your logo is clicked
homepage: https://docs.alnoda.org
host_url: https://docs.alnoda.org
plugins:
- include-markdown
# Enable Macros and jinja2 templates
- macros:
module_name: macros/helpers
- awesome-pages
# mermaid2 diagrams: https://mermaid-js.github.io/mermaid/#/
- mermaid2:
arguments:
theme: forest # default, forest, dark, neutral, base
themeCSS: ".er.entityLabel{fill: black;} .messageLine0{stroke: orange;} .messageLine1{stroke: orange;} #arrowhead{fill: orange;} .messageText{fill: black; stroke: black}"
markdown_extensions:
- def_list
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.arithmatex:
generic: true
- admonition
- pymdownx.inlinehilite
- pymdownx.details
- pymdownx.superfences:
# make exceptions to highlighting of code:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:mermaid2.fence_mermaid
- pymdownx.tabbed
- abbr
- pymdownx.snippets
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.keys
- pymdownx.betterem
- pymdownx.caret
- pymdownx.critic
- pymdownx.escapeall
- pymdownx.smartsymbols
- pymdownx.tilde:
smart_delete: true
- footnotes
extra_javascript:
- javascripts/config.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
- https://unpkg.com/mermaid/dist/mermaid.min.js