From 84095a80e874f84cca057569ce54bd1c733ffcf8 Mon Sep 17 00:00:00 2001 From: River M <97197236+River-Mochi@users.noreply.github.com> Date: Mon, 3 Apr 2023 23:19:17 -0700 Subject: [PATCH] fix Mkdocs edit button (#1642) * fix: edit button mkdocs * fix: edit button on mkdocs - should open edit page for dev branch and requires login if person is not already logged into github * add favicons for the mkdocs * Delete android-chrome-192x192.png * Delete android-chrome-512x512.png * Delete favicon-16x16.png * Delete favicon.ico * Delete favicon-32x32.png * Delete apple-touch-icon.png * Create temp * add favicon for mkdocs * mkdocs - highlighting for source code - Enables highlighting of source code in code blocks - allow highlighting for other languages that are not default 23 - add favicon and custom location (until folder names are changed to /docs and /doc/img * Delete temp * Add files via upload * organize mkdocs * add mkdocs extensions & plugins * remove favicon * Delete favicon.ico * Delete font-license.txt --- mkdocs.yml | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) 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