mirror of
https://github.com/Ralim/IronOS.git
synced 2025-02-26 07:53:55 +00:00
4649df6914
* mkdocs.yml: unify formatting style * Docs/README.md: add auto-generated README.md file for Documentation/ directory * Docs/README.md: fix refs * Docs/README.md: fix locations * Docs/README.md: trying workaround spaces in filenames for refs * Documentation/README.md: update generated file trying to fix all formatting issues * Documentation/README.md: reduce title size * Documentation/README.md: add link for official online docs * scripts/deploy.sh: implement docs_readme function * deploy.sh: add overwrite warning in help output * deploy.sh: try to fix shellcheck warnings * deploy.sh:docs_readme() - show note message only if README should be updated * deploy.sh:docs_readme() - fix shellcheck * github/push: add Documentation/README.md check * github/push: force usage of /bin/sh for deploy.sh script * testing, testing, testing * deploy.sh:docs_readme() - make error-related message more clear about what to donext * Revert change used only to test failure on github CI
58 lines
1.4 KiB
YAML
58 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/
|
|
|
|
# Dir & location config
|
|
docs_dir: ../Documentation
|
|
edit_uri: edit/dev/Documentation/
|
|
|
|
# Theme and config
|
|
theme:
|
|
name: readthedocs
|
|
highlightsjs: true
|
|
hljs_languages:
|
|
- yaml
|
|
|
|
# Navigation structure
|
|
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
|