Files
documentation/mkdocs.yml
Ricardo Pardini b3d71d3e61 "Welcome Guide" which was for armbian-next (#352)
* remove all references to Vagrant, as it is no longer supported

* FEL boot is no more

* format mkdocs.yml - no real changes

* The Welcome Guide, or: blergh "What's New" back from `armbian-next`
2024-03-08 15:51:11 +01:00

120 lines
3.9 KiB
YAML

site_name: Armbian Documentation
site_author: "Armbian team"
copyright: Copyright © 2015 - 2023 Armbian team
repo_url: https://github.com/armbian/documentation
repo_name: armbian/documentation
theme:
name: material
custom_dir: overrides
logo: images/logo.svg
icon:
repo: fontawesome/brands/github-alt
palette:
- scheme: default
primary: red
accent: red
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- scheme: slate
primary: red
accent: red
toggle:
icon: material/toggle-switch
name: Switch to light mode
favicon: images/logo.png
features:
- navigation.tabs
- navigation.top
- toc.integrate
extra:
analytics:
provider: google
property: UA-284946-9
social:
- icon: fontawesome/brands/github
link: https://github.com/armbian
- icon: fontawesome/brands/twitter
link: https://twitter.com/armbian
plugins:
- search
#- with-pdf:
# author: Armbian documentation team
# copyright: © 2023 by Armbian
# cover_title: Armbian documentation
# cover_subtitle: Linux for ARM development boards
markdown_extensions:
- smarty
- footnotes
- mdx_truly_sane_lists
- toc:
permalink: True
- pymdownx.highlight:
auto_title: true
linenums: true
use_pygments: true
- pymdownx.superfences
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
nav:
- Home: index.md
- "User Guide":
- "Getting Started": "User-Guide_Getting-Started.md"
- "Quick facts": "Quick_facts.md"
- "Troubleshooting": "User-Guide_Basic-Troubleshooting.md"
- "Recovery": "User-Guide_Recovery.md"
- "Frequently asked questions": "User-Guide_FAQ.md"
- "Advanced Features": "User-Guide_Advanced-Features.md"
- "Fine Tuning": "User-Guide_Fine-Tuning.md"
- "Armbian config": "User-Guide_Armbian-Config.md"
- "Armbian DT overlays": "User-Guide_Armbian_overlays.md"
- "Board Support Rules": "User-Guide_Board-Support-Rules.md"
- "Hardware Notes":
- "Allwinner (Generic)": "Hardware_Allwinner.md"
- "A10 and A20": "Hardware_Allwinner-A20.md"
- "H2+ and H3": "Hardware_Allwinner-H3.md"
- "H5 and A64": "Hardware_Allwinner-H5-A64.md"
- "H6": "Hardware_Allwinner-H6.md"
- "Freescale i.MX6": "Hardware_Freescale-imx6.md"
- "Marvell Armada": "Hardware_Marvell.md"
- "Rockchip": "Hardware_Rockchip.md"
- "Developer Guide":
- "Welcome": "Developer-Guide_Welcome.md"
- "Building Armbian": "Developer-Guide_Build-Preparation.md"
- "Building with Docker": "Developer-Guide_Building-with-Docker.md"
- "Build Options": "Developer-Guide_Build-Options.md"
- "User Configurations": "Developer-Guide_User-Configurations.md"
- "Extensions": "Developer-Guide_Extensions.md"
- "Hooks": "Developer-Guide_Extensions-Hooks.md" # This file is autogenerated by build system.
- "Adding new board or family": "Developer-Guide_Adding-Board-Family.md"
- "Contributor Process":
- "Contribute": "Process_Contribute.md"
- "Merge Policy": "Process_Merge-Policy.md"
- "Continuous integration": "Process_CI.md"
- "Documentation": "Process_Documentation.md"
- "Development Code Review Procedures and Guidelines": "Development-Code_Review_Procedures_and_Guidelines.md"
- "Release management":
- "Model": "Process_Release-Model.md"
- "Changelog": "Release_Changelog.md"
- "Workflow (Jira)": "Process_Managing_Workflow.md"
- "Board Maintainers": "Release_Board-Maintainers.md"
- "Board Maintainers Procedures and Guidelines": "Board_Maintainers_Procedures_and_Guidelines.md"
- "Community":
- "IRC/Discord/Matrix": "Community_IRC.md"
- "Governance": "Community_Governance.md"
- "Seed our torrents": "Community_Torrent.md"