armbian/documentation
Fork: 159 Star: 171 (更新于 2024-05-08 11:10:44)
license: GPL-3.0
Language: Python .
Armbian Linux Documentation
最后发布版本: 808370e ( 2023-11-16 14:55:22)
Armbian Documentation
Overview
Documentation is written in markdown and stored in the docs/
subfolder. Images go in docs/images
.
This repo is meant for storing and quick glances. Official output is https://docs.armbian.com.
Armbian Documentation is available in the following formats:
Contributing
This site is built with mkdocs and depends on mkdocs-material.
Armbian Documentation naming of document files follows this rules:
[Parent-Topic-Example]_[Child-Topic]-example.md
Parent-Topic-Name
and Child-Topic-Name
are separated by an underscore _
. Hyphens -
are automatically converted to space.
Please try to avoid creating new parent topics unless absolutely necessary.
Current Parent Topics:
- User Guide
- Hardware notes
- Developer Guide
- Contributor Process
- Release management
- Community
See the document template before you writing any content.
Working on the content
git clone https://github.com/armbian/documentation
pip install -r requirements.txt
mkdocs build --clean && mkdocs serve
You will be able to make edits to existing files and observe the results in real time.
After changing text in an existing file, use this command to rebuild and view the documentation:
mkdocs build --clean && mkdocs serve
After adding a new file, either hand-edit mkdocs.yml
, or re-run tools/mkArmbianDocs.py
unless making changes to the structure of the docs/
folder. (See below)
Generate tools
mkArmbianDocs.py
Generate mkdocs.yml
based on the contents of docs/
folder
- Command-line options for input and output directories
- Requires install requirement
- You don't need to run it every time unless making changes to the structure of the
docs/
folder - See
mkArmbianDocs.py -h
for help
From the parent folder of the repo, run:
python3 tools/mkArmbianDocs.py && mkdocs build
This will generate the mkdocs.yml
and publish built HTML to the site/
folder.
最近版本更新:(数据更新于 1970-01-01 00:00:00)
2023-11-16 14:55:22 808370e
2023-11-16 04:22:58 a134d7c
2023-11-15 21:20:11 05e2b45
2023-11-08 17:51:50 a8cf447
2023-10-30 16:10:09 542cbfa
2023-10-26 04:13:34 2a0101e
2023-10-12 04:15:34 b3101c7
2023-09-21 00:30:26 70bcf44
2023-09-13 00:57:59 4e691bf
2023-09-11 23:56:03 f216db3
主题(topics):
docs, documentation, framework, manual, user
armbian/documentation同语言 Python最近更新仓库
2024-05-18 00:28:45 huggingface/transformers
2024-05-17 15:17:13 xorbitsai/inference
2024-05-17 15:13:07 microsoft/promptflow
2024-05-17 15:04:06 jxxghp/MoviePilot
2024-05-17 02:09:05 xtekky/gpt4free
2024-05-16 21:11:59 foundryzero/binder-trace