Skip to content

Commit 6cb5487

Browse files
committed
docs: add myst.yml and deploy-docs workflow
1 parent 0a49f06 commit 6cb5487

2 files changed

Lines changed: 59 additions & 0 deletions

File tree

.github/workflows/deploy-docs.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
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+
workflow_dispatch:
10+
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
concurrency:
17+
group: pages
18+
cancel-in-progress: false
19+
20+
env:
21+
BASE_URL: /${{ github.event.repository.name }}
22+
23+
jobs:
24+
deploy:
25+
environment:
26+
name: github-pages
27+
url: ${{ steps.deployment.outputs.page_url }}
28+
runs-on: ubuntu-latest
29+
defaults:
30+
run:
31+
working-directory: docs
32+
steps:
33+
- uses: actions/checkout@v4
34+
- uses: actions/setup-node@v4
35+
with:
36+
node-version: 18
37+
- name: Install MyST
38+
run: npm install -g mystmd
39+
- name: Build HTML
40+
run: myst build --html
41+
- name: Upload artifact
42+
uses: actions/upload-pages-artifact@v3
43+
with:
44+
path: docs/_build/html
45+
- name: Deploy to GitHub Pages
46+
id: deployment
47+
uses: actions/deploy-pages@v4

docs/myst.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
version: 1
2+
project:
3+
title: quanttide-project-toolkit
4+
description: 一套跨语言的项目管理 SDK,覆盖数据模型、API 路由、UI 组件
5+
github: https://github.com/quanttide/quanttide-project-toolkit
6+
toc:
7+
- file: user/index.md
8+
- file: dev/index.md
9+
site:
10+
template: book-theme
11+
options:
12+
folders: false

0 commit comments

Comments
 (0)