doc-smith-build
1
总安装量
1
周安装量
#47596
全站排名
安装命令
npx skills add https://github.com/aigne-io/doc-smith-skills --skill doc-smith-build
Agent 安装分布
amp
1
opencode
1
cursor
1
kimi-cli
1
codex
1
github-copilot
1
Skill 文档
Doc-Smith HTML æå»º
忍¡å¼æå»ºï¼--nav çæå¯¼èªåéæèµæºï¼--doc æå»ºåç¯ææ¡£ã
ç¨æ³
# çæ nav.js + å¤å¶èµæº + å建éå®å
node skills/doc-smith-build/scripts/build.mjs \
--nav --workspace .aigne/doc-smith --output .aigne/doc-smith/dist
# æå»ºåç¯ææ¡£
node skills/doc-smith-build/scripts/build.mjs \
--doc .aigne/doc-smith/docs/overview/zh.md --path /overview \
--workspace .aigne/doc-smith --output .aigne/doc-smith/dist
é项
| Option | Alias | Description |
|---|---|---|
--nav |
çæ nav.jsãå¤å¶ CSSãå建éå®åé¡µé¢ | |
--doc <file> |
æå»ºåç¯ MD æä»¶ä¸º HTML | |
--path <path> |
ææ¡£è·¯å¾ï¼å¦ /overviewï¼ï¼--doc 模å¼å¿
é |
|
--workspace <path> |
-w |
Doc-Smith workspaceï¼é»è®¤ .aigne/doc-smithï¼ |
--output <path> |
-o |
è¾åºç®å½ï¼é»è®¤ <workspace>/distï¼ |
模å¼è¯´æ
–nav 模å¼
ä» document-structure.yaml + config.yaml çæå¯¼èªæ°æ®åéæèµæºã
è¾åºï¼
assets/nav.jsâ å¯¼èªæ°æ®ï¼window.__DS_NAV__ = {...}ï¼ï¼ä¾§è¾¹æ åè¯è¨åæ¢ç±æ¤é©±å¨assets/docsmith.cssâ å ç½®åºç¡æ ·å¼assets/theme.cssâ ç¨æ·ä¸»é¢ï¼ä¸å卿¶å建空æä»¶ï¼index.htmlâ æ ¹éå®å{lang}/index.htmlâ è¯è¨éå®å
è°ç¨æ¶æºï¼ åå§åæ¶ãææ¡£ç»æåæ´åã
–doc 模å¼
æå»ºåç¯ MD æä»¶ä¸ºå®æ´ HTML 页é¢ã
è¾å
¥ï¼ MD æä»¶è·¯å¾ + ææ¡£ path
è¾åºï¼ dist/{lang}/docs/{path}.html
èè´£ï¼
- Markdown â HTML 转æ¢ï¼markdown-itï¼
- å¥ HTML 骨æ¶ï¼data-ds éç¹ï¼
- çæ TOCï¼é¡µé¢å èï¼
- å¤çå¾çå ä½ç¬¦ï¼
<!-- afs:image ... -->ï¼ /assets/è·¯å¾è½¬æ¢ä¸ºç¸å¯¹è·¯å¾ï¼è§ä¸æ¹è·¯å¾å¥çº¦ï¼- æ¼æ¥éæèµæºå¼ç¨ï¼CSS + nav.jsï¼
ä¸è´è´£ï¼ å¯¼èªæ¸²æï¼nav.js 客æ·ç«¯å®æï¼ãMD æ¸ çï¼è°ç¨æ¹è´è´£ï¼ã
è·¯å¾å¥çº¦
MD æä»¶ä¸ä½¿ç¨ /assets/ ç»å¯¹è·¯å¾å¼ç¨èµæºï¼build.mjs èªå¨è½¬æ¢ä¸ºç¸å¯¹è·¯å¾ï¼
| MD ä¸åæ³ | HTML è¾åºï¼depth=1ï¼ | HTML è¾åºï¼depth=2ï¼ |
|---|---|---|
 |
../../assets/logo.png |
../../../assets/logo.png |
- è·¯å¾å
å«
..çè§ä¸ºéæ³ï¼ä¸è½¬æ¢ï¼é²éåæ»å»ï¼ - æ§æ ¼å¼
../../assets/ä»ç±å·²æé»è¾å¤çï¼ååå ¼å®¹ï¼ - å¤é¨ URL ä¸åå½±å
å¯¼èªæ¶æ
ä¾§è¾¹æ åè¯è¨åæ¢ç± nav.js å¨å®¢æ·ç«¯æ¸²æï¼
- 使ç¨
<script src>å è½½ï¼å ¼å®¹file://åhttp://åè®®ï¼ - æ´æ°ææ¡£ç»æåªééæ°çæ nav.jsï¼æ ééå»ºææ HTML 页é¢
- TOC ä»å¨æå»ºæ¶å èçæï¼é¡µé¢ç¹æå 容ï¼
é误å¤ç
| é误类å | å¤çæ¹å¼ |
|---|---|
| workspace ä¸åå¨ | æ¥åæç¡®é误 |
| document-structure.yaml 缺失 | æ¥åæç¡®é误 |
| MD æä»¶ä¸åå¨ | æ¥åæç¡®é误 |
--doc ç¼ºå° --path |
æ¥åæç¡®é误 |
| ä¾èµæªå®è£ | å¨ scripts ç®å½æ§è¡ npm install |
ä¾èµæªå®è£
妿æ§è¡èæ¬æ¶åºç°æ¨¡åæ¾ä¸å°çé误ï¼éè¦å å®è£ ä¾èµï¼
cd skills/doc-smith-build/scripts && npm install
è¾åºç»æ
.aigne/doc-smith/dist/
âââ index.html # éå®åå°ä¸»è¯è¨
âââ zh/
â âââ index.html # 䏿é¦é¡µ
â âââ docs/
â âââ overview.html
â âââ guide/
â âââ intro.html
âââ en/
â âââ index.html # è±æé¦é¡µ
â âââ docs/
â âââ ...
âââ assets/
âââ docsmith.css # å
ç½®åºç¡æ ·å¼
âââ theme.css # ç¨æ·ä¸»é¢
âââ nav.js # å¯¼èªæ°æ®ï¼ä¾§è¾¹æ + è¯è¨åæ¢ï¼