Files
sunvpy-docs/README.md

99 lines
2.2 KiB
Markdown
Raw Normal View History

# .zread <20><> sunvpy <20><>̬<EFBFBD>ĵ<EFBFBD>վ<EFBFBD><D5BE><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
2026-04-10 13:47:53 +08:00
<EFBFBD><EFBFBD> `sunvpy` wiki markdown <20>ĵ<EFBFBD><C4B5><EFBFBD><EFBFBD><EFBFBD>Ϊ<EFBFBD><CEAA><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ľ<EFBFBD>̬<EFBFBD>ĵ<EFBFBD>վ<EFBFBD>
2026-04-10 13:47:53 +08:00
## Ŀ¼<C4BF>
2026-04-10 13:47:53 +08:00
```
.zread/
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> build.py # <20><><EFBFBD><EFBFBD><EFBFBD>ű<EFBFBD>
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> wiki/ # <20>ĵ<EFBFBD>Դ<EFBFBD>ļ<EFBFBD>
<EFBFBD><EFBFBD> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD> current # <20><>ǰ<EFBFBD>汾ָ<E6B1BE><D6B8>
<EFBFBD><EFBFBD> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD> versions/ # <20><><EFBFBD><EFBFBD><E6B1BE><EFBFBD><EFBFBD> markdown + wiki.json
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> docs/ # <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>̬վ<CCAC>
<20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD> index.html
<20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD> css/style.css
<20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD> js/app.js
<20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD> js/search.js
<20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD> data/ # nav.json, search-index.json
<20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD> content/ # markdown <20>ļ<EFBFBD><C4BC><EFBFBD><EFBFBD><EFBFBD>
2026-04-10 13:47:53 +08:00
```
## <20><><EFBFBD><EFBFBD><EFBFBD>ĵ<EFBFBD>
2026-04-10 13:47:53 +08:00
```bash
# Ĭ<>Ϲ<EFBFBD><CFB9><EFBFBD><EFBFBD><EFBFBD><EFBFBD>°汾
2026-04-10 13:47:53 +08:00
python build.py
# ָ<><D6B8><EFBFBD>
2026-04-10 13:47:53 +08:00
python build.py --version 2026-04-07-163229
# ָ<><D6B8><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ŀ¼
2026-04-10 13:47:53 +08:00
python build.py --output /path/to/output
```
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>̣<EFBFBD>
1. <20><>ȡ `wiki/versions/<version>/wiki.json` <20>
2. <20><><EFBFBD><EFBFBD> `data/nav.json`<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
3. <20><><EFBFBD><EFBFBD> `data/search-index.json`<EFBFBD><EFBFBD>ȫ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
4. <20><><EFBFBD><EFBFBD> markdown <20>ļ<EFBFBD><C4BC><EFBFBD> `content/`
2026-04-10 13:47:53 +08:00
## <20><EFBFBD>ĵ<EFBFBD>
2026-04-10 13:47:53 +08:00
`docs/` <20>Ǵ<EFBFBD><C7B4><EFBFBD>̬վ<CCAC><EFBFBD><E3A3AC><EFBFBD><EFBFBD><EFBFBD><EFBFBD> HTTP <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>йܼ<D0B9><DCBC>ɡ<EFBFBD><C9A1><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ѡһ<D1A1>֣<EFBFBD>
2026-04-10 13:47:53 +08:00
### Python
```bash
cd docs
python -m http.server 8080
# <20><><EFBFBD><EFBFBD> http://localhost:8080
2026-04-10 13:47:53 +08:00
```
### Node.js
```bash
npx serve docs -p 8080
# <20><><EFBFBD><EFBFBD> http://localhost:8080
2026-04-10 13:47:53 +08:00
```
### VS Code
<EFBFBD><EFBFBD>װ **Live Server** <20><>չ<EFBFBD><D5B9><EFBFBD>Ҽ<EFBFBD> `docs/index.html` <20><> "Open with Live Server"<22><>
2026-04-10 13:47:53 +08:00
### ֱ<><D6B1>˫<EFBFBD><CBAB>
2026-04-10 13:47:53 +08:00
˫<EFBFBD><EFBFBD> `docs/index.html` <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>򿪣<EFBFBD><F2BFAAA3><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> CDN <20><>Դ<EFBFBD><D4B4><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Mermaid<69><64><EFBFBD><EFBFBD>Ҫ<EFBFBD><D2AA><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ӡ<EFBFBD>
2026-04-10 13:47:53 +08:00
## վ<><EFBFBD><E3B9A6>
2026-04-10 13:47:53 +08:00
- **<2A><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>** <20><> <20><> section/group <20>Զ<EFBFBD><D4B6><EFBFBD>֯
- **ȫ<><C8AB><EFBFBD><EFBFBD><EFBFBD><EFBFBD>** <20><> <20><><EFBFBD><EFBFBD> Fuse.js<6A><73>֧<EFBFBD><D6A7> `Ctrl+K` <20><><EFBFBD>ݼ<EFBFBD>
- **<2A><>ɫ/dzɫ<C7B3><C9AB><EFBFBD><EFBFBD><EFBFBD>л<EFBFBD>**
- **<2A><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>** <20><> highlight.js<6A><73>Python<6F><6E>
- **Mermaid ͼ<><CDBC><EFBFBD><EFBFBD>Ⱦ**
- **ҳ<><D2B3><EFBFBD><EFBFBD>Ŀ¼<C4BF><C2BC>TOC<4F><43>**
- **<2A>ƶ<EFBFBD><C6B6><EFBFBD><EFBFBD><EFBFBD>Ӧʽ<D3A6><CABD><EFBFBD><EFBFBD>**
2026-04-10 13:47:53 +08:00
## <20><><EFBFBD><EFBFBD>ջ
2026-04-10 13:47:53 +08:00
| <20><>; | <20><><EFBFBD><EFBFBD> |
2026-04-10 13:47:53 +08:00
|------|------|
| Markdown <20><>Ⱦ | marked.js (CDN) |
| <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> | highlight.js (CDN) |
| ͼ<><CDBC> | mermaid.js (CDN) |
| <20><><EFBFBD><EFBFBD> | fuse.js (CDN) |
## <20>ĵ<EFBFBD><C4B5><EFBFBD><EFBFBD>ݸ<EFBFBD><DDB8><EFBFBD>
<EFBFBD><EFBFBD> 45 ƪ<>ĵ<EFBFBD><C4B5><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>½ڣ<C2BD>
- **<2A><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>** <20><> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>װ<EFBFBD><D7B0><EFBFBD>á<EFBFBD><C3A1><EFBFBD>һ<EFBFBD><D2BB><EFBFBD>ű<EFBFBD>
- **<2A><><EFBFBD>ĸ<EFBFBD><C4B8><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ܹ<EFBFBD>** <20><> ϵͳ<CFB5>ܹ<EFBFBD><DCB9><EFBFBD>SWIG <20><>װ<EFBFBD><D7B0><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ռ䡢Mixin ģʽ
- **ѡ<><D1A1><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ѯ** <20><> ѡ<>񼯲<EFBFBD><F1BCAFB2><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Զ<EFBFBD>д
- **<2A><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>༭** <20><> <20><><EFBFBD>󴴽<EFBFBD><><C9BE><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
- **<2A><><EFBFBD>ݽ<EFBFBD><DDBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EBB5BC>** <20><> <20><><EFBFBD>ݵ<EFBFBD><DDB5><EFBFBD><EBB5BC><EFBFBD><EFBFBD><EFBFBD>Զ<EFBFBD><D4B6><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
- **<2A><><EFBFBD>ݼ<EFBFBD><DDBC><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>֤** <20><> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>¼<EFBFBD><C2BC><EFBFBD>Զ<EFBFBD><D4B6><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
- **<2A>߼<EFBFBD><DFBC><EFBFBD><EFBFBD><EFBFBD>** <20><> <20><><EFBFBD><EFBFBD><EFBFBD>ռ<EFBFBD><D5BC><EFBFBD>Ϣ<EFBFBD><CFA2>·<EFBFBD><C2B7><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>־<EFBFBD><D6BE><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
- **<2A>ο<EFBFBD><CEBF>ֲ<EFBFBD>** <20><> SSProcessManager API<50><49><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ߺ<EFBFBD><DFBA><EFBFBD>