9a33fc0a69
* Update Readme & improve md layout - ESPHome now supports LibreTiny natively - Added extra PIO docs references - Reworded some sections slightly, to accomodate proper grammar - PIO deprecated the `platformio platform install` command, replaced this with the official recommendation/replacement * Use backslash for line break, revert changing indent --------- Co-authored-by: Kuba Szczodrzyński <kuba@szczodrzynski.pl>
75 lines
2.2 KiB
YAML
75 lines
2.2 KiB
YAML
site_name: LibreTiny
|
|
docs_dir: .
|
|
|
|
site_url: https://docs.libretiny.eu/
|
|
repo_url: https://github.com/libretiny-eu/libretiny
|
|
|
|
theme:
|
|
name: material
|
|
features:
|
|
- content.code.annotate
|
|
- content.code.copy
|
|
- content.tabs.link
|
|
- navigation.instant
|
|
- navigation.tracking
|
|
- navigation.path
|
|
- search.suggest
|
|
- search.highlight
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
|
|
plugins:
|
|
- same-dir
|
|
- mkdoxy:
|
|
projects:
|
|
# project names must be alphanumeric, else snippets won't work
|
|
ltapi:
|
|
src-dirs: cores/common/
|
|
doxy-cfg:
|
|
OPTIMIZE_OUTPUT_FOR_C: YES
|
|
PREDEFINED: __cplusplus DOXYGEN=1
|
|
CASE_SENSE_NAMES: NO
|
|
save-api: .
|
|
- literate-nav:
|
|
nav_file: SUMMARY.md
|
|
- redirects:
|
|
redirect_maps:
|
|
"link/cloudcutter-video.md": 'https://www.youtube.com/watch?v=sSj8f-HCHQ0'
|
|
"link/cloudcutter-digiblur.md": 'https://digiblur.com/2023/08/19/updated-tuya-cloudcutter-with-esphome-bk7231-how-to-guide/'
|
|
"link/boards.md": "docs/status/supported.md"
|
|
"link/gpio-access.md": "docs/getting-started/gpio.md"
|
|
"link/config.md": "docs/dev/config.md"
|
|
"link/config-debug.md": "docs/dev/config.md#per-module-logging-debugging"
|
|
"link/config-serial.md": "docs/dev/config.md#serial-output"
|
|
"link/flashing-beken-72xx.md": "docs/platform/beken-72xx/README.md#flashing"
|
|
"link/flashing-realtek-ambz.md": "docs/platform/realtek-ambz/README.md#flashing"
|
|
"link/bk72xx-keys.md": "docs/platform/beken-72xx/keys.md"
|
|
"link/kickstart.md": "https://github.com/libretiny-eu/esphome-kickstart/releases/latest"
|
|
- section-index
|
|
- include-markdown
|
|
- search
|
|
|
|
extra_css:
|
|
- docs/style.css
|
|
|
|
extra_javascript:
|
|
- https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
|
|
- docs/script.js
|
|
|
|
markdown_extensions:
|
|
- md_in_html
|
|
- admonition
|
|
- attr_list
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.escapeall:
|
|
hardbreak: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.details
|
|
- pymdownx.superfences
|