File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ name : Deploy docs to GitHub Pages
2+
3+ on :
4+ push :
5+ branches : [main]
6+ paths :
7+ - docs/**
8+ - .github/workflows/deploy-docs.yml
9+
10+ jobs :
11+ build :
12+ runs-on : ubuntu-latest
13+ steps :
14+ - uses : actions/checkout@v4
15+ - uses : actions/setup-python@v5
16+ with :
17+ python-version : " 3.12"
18+ - run : pip install mystmd
19+ - run : myst build --html
20+ working-directory : docs
21+ env :
22+ BASE_URL : /qtcloud-write/
23+ - run : cp docs/_build/html/index.html docs/_build/html/404.html
24+ - uses : actions/upload-pages-artifact@v3
25+ with :
26+ path : docs/_build/html
27+
28+ deploy :
29+ needs : build
30+ runs-on : ubuntu-latest
31+ permissions :
32+ pages : write
33+ id-token : write
34+ environment :
35+ name : github-pages
36+ url : ${{ steps.deployment.outputs.page_url }}
37+ steps :
38+ - uses : actions/deploy-pages@v4
Original file line number Diff line number Diff line change 1+ _build /
Original file line number Diff line number Diff line change 1+ # See docs at: https://mystmd.org
2+ version : 1
3+ project :
4+ title : 量潮写作云
5+ description : QtCloud Write 产品文档
6+ keywords : []
7+ authors : []
8+ toc :
9+ - file : index.md
10+ - title : BRD(业务需求文档)
11+ children :
12+ - file : brd/index.md
13+ - title : PRD(产品需求文档)
14+ children :
15+ - file : prd/index.md
16+ - file : prd/discern.md
17+ - file : prd/inherit.md
18+ - title : ADD(架构设计文档)
19+ children :
20+ - file : add/index.md
21+ - title : IXD(交互设计文档)
22+ children :
23+ - file : ixd/index.md
24+ - file : ixd/review.md
25+ - title : PMD(项目管理文档)
26+ children :
27+ - file : pmd/index.md
28+ - title : QA(质量保证文档)
29+ children :
30+ - file : qa/index.md
31+ site :
32+ template : book-theme
You can’t perform that action at this time.
0 commit comments