mirror of
https://github.com/Ralim/IronOS.git
synced 2025-02-26 07:53:55 +00:00
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
This commit is contained in:
31
mkdocs.yml
31
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
|
||||
|
||||
Reference in New Issue
Block a user