35ba6e9975
Renders the root markdown (manual, tools, changelog) into a static, searchable HTML site with client-side (lunr.js) search and a dark/light theme. Built in Docker via website/build-docs.sh (no host installs). Public URL is set at build time with SITE_URL=... (default is a neutral placeholder; the site works at any URL since site_url only affects the sitemap/canonical links). Generated output (website/_build/) is gitignored. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
63 lines
1.8 KiB
YAML
63 lines
1.8 KiB
YAML
site_name: FreeTRX Documentation
|
|
site_description: User manual for the FreeTRX firmware (an OpenGD77 fork for MD-UV380 / DM-1701)
|
|
site_author: Marcus, DK1DA
|
|
# Public URL where the docs are hosted. Only affects the sitemap / canonical links /
|
|
# search-share URLs — the site itself works at ANY domain or path (relative links).
|
|
# Override at build time without editing this file: SITE_URL=https://your.url/ ./build-docs.sh
|
|
site_url: !ENV [SITE_URL, "https://docs.example.com/"]
|
|
repo_name: DK1DA/FreeTRX
|
|
repo_url: https://git.dk1da.de/DK1DA/FreeTRX
|
|
|
|
# Source markdown is assembled into _build/docs by build-docs.sh; output goes to _build/site.
|
|
docs_dir: _build/docs
|
|
site_dir: _build/site
|
|
use_directory_urls: true
|
|
|
|
theme:
|
|
name: material
|
|
language: en
|
|
palette:
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: green
|
|
accent: green
|
|
toggle:
|
|
icon: material/weather-night
|
|
name: Switch to dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: green
|
|
accent: green
|
|
toggle:
|
|
icon: material/weather-sunny
|
|
name: Switch to light mode
|
|
features:
|
|
- navigation.top
|
|
- navigation.sections
|
|
- navigation.instant
|
|
- search.suggest
|
|
- search.highlight
|
|
- search.share
|
|
- content.code.copy
|
|
- toc.follow
|
|
|
|
plugins:
|
|
- search # built-in client-side (lunr.js) full-text search — no external service
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- User Manual: MANUAL.md
|
|
- Building & Flashing: TOOLS.md
|
|
- Changelog: CHANGELOG.md
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- attr_list
|
|
- tables
|
|
- toc:
|
|
permalink: true
|
|
- pymdownx.superfences
|
|
- pymdownx.highlight
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|