mirror of
https://github.com/Ralim/IronOS.git
synced 2025-02-26 07:53:55 +00:00
8c90d3dee2
* 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 * fix mkdocs for markdown extensions fixed the name since this is not a materials theme. * add plugins to mkdocs * add mkdocs git-revision-date displays the last revision date of the current page of the documentation based on Git. this could be displayed at the bottom of each page.
57 lines
1.4 KiB
YAML
57 lines
1.4 KiB
YAML
# Project info
|
|
site_name: IronOS
|
|
site_url: https://ralim.github.io/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
|
|
- Flashing the firmware:
|
|
- MHP30: Flashing/MHP30.md
|
|
- Pinecil V1: Flashing/Pinecil V1.md
|
|
- Pinecil V2: Flashing/Pinecil V2.md
|
|
- TS80(P): Flashing/TS80(P).md
|
|
- TS100: Flashing/TS100.md
|
|
- Operation:
|
|
- Main Menu: Menu.md
|
|
- Settings: Settings.md
|
|
- Debug Menu: DebugMenu.md
|
|
- Power: Power.md
|
|
- Temperature: Temperature.md
|
|
- Startup Logo: Logo.md
|
|
- Hardware:
|
|
- Hall Sensor (Pinecil): HallSensor.md
|
|
- Hardware Notes: Hardware.md
|
|
- Troubleshooting: Troubleshooting.md
|
|
- Known Hardware Issues: HardwareIssues.md
|
|
- Translations: Translation.md
|
|
- Development: Development.md
|
|
|
|
# Plugins
|
|
plugins:
|
|
- search
|
|
- autolinks
|
|
- awesome-pages
|
|
- git-revision-date
|
|
|
|
|
|
# Markdown Extensions
|
|
markdown_extensions:
|
|
- attr_list
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:pymdownx.emoji.twemoji
|
|
emoji_generator: !!python/name:pymdownx.emoji.to_svg
|