b524a99ff2
* Root directory refactoring: - move info about Bootup Logo from a sepatate README to main README; - replace separate root scripts build.sh and start_dev.sh by root Makefile; - make Scripts directory and move there: flash_ts100_linux.sh script, ci/ directory, dockerfile, LICENSE_RELEASE, and PULL_REQUEST_TEMPLATE; - reconfigure build & deploy scripts according to changes * Scripts => scripts * Scripts -> scripts: re-add missing renamed files * Directories refactoring: add top-level Makefile, add scripts/deploy.sh script, move github templates from top-level dir to .github, organize files inside Development Resources * Update scripts/deploy.sh accroding to codestyle syntax shellcheck * Makefile: add docs-deploy target for mkdocs gh-deploy * Rename IronOS.yml > Env.yml, update related files * Docs configs: remove empty characters * docs/devel: update usage of new script
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
|