Closed KmolYuan closed 5 years ago
搭配 Readthedocs 服務可做到自動編譯 html 和 PDF、打包 zip,而且只需安裝 MkDocs 套件便能進行近端預覽。
# 安裝 MkDocs
pip install mkdocs
# 創立新專案(建立 mkdocs.md 與 doc/index.md)
mkdocs new .
# 近端預覽
mkdocs serve
Pyslvs 設定:https://github.com/KmolYuan/Pyslvs-UI/blob/dev/mkdocs.yml
Pyslvs 遠端:https://pyslvs-ui.readthedocs.io/en/latest/?badge=latest
Python 套件,只需 YAML 設定檔與 doc 目錄,跟原始碼並存。
https://www.mkdocs.org/
部署:
https://mkdocs.readthedocs.io/en/stable/user-guide/deploying-your-docs/
可參考 lark-parser/lark 倉儲。