diff --git a/mkdocs.yml b/mkdocs.yml index da403d62..0d84f662 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,8 +1,21 @@ +# Project info site_name: IronOS site_url: https://ralim.github.io/IronOS/ -repo_url: https://github.com/ralim/IronOS/ site_description: "IronOS Open Source Soldering Iron firmware for Miniware and Pinecil" + +# repo config +repo_url: https://github.com/ralim/IronOS/ + docs_dir: Documentation +edit_uri: edit/dev/Documentation/ + +# Theme and config +theme: + name: readthedocs + highlightsjs: true + hljs_languages: + - yaml + nav: - Home: index.md - Getting Started: GettingStarted.md @@ -26,5 +39,17 @@ nav: - Known Hardware Issues: HardwareIssues.md - Translations: Translation.md - Development: Development.md - -theme: readthedocs + +# Plugins +plugins: + - autolinks + - awesome-pages + - git-revision-date + - search + +# Markdown Extensions +markdown_extensions: + - attr_list + - pymdownx.emoji: + emoji_index: !!python/name:materialx.emoji.twemoji + emoji_generator: !!python/name:materialx.emoji.to_svg