文档发布说明¶
这套结构的目标很简单:博客文章继续走 Hexo,文档内容走 MkDocs,最后一起发布到 GitHub Pages。
发布路径¶
sequenceDiagram
participant O as Obsidian 或本地 Markdown
participant R as GitHub 仓库
participant H as Hexo
participant M as MkDocs
participant P as GitHub Pages
O->>R: 提交博客文章或文档
R->>H: 构建博客到 public/
R->>M: 构建文档到 public/docs/
H->>P: 发布 /blog/
M->>P: 发布 /blog/docs/
文件应该放哪里¶
博客文章放这里:
source/_posts/
文档页面放这里:
docs-site/docs/
MkDocs 配置文件在这里:
docs-site/mkdocs.yml
后面可以接到 Obsidian 插件¶
后续可以在 Obsidian 插件里增加一个按钮:
发布为文档
它和“发布当前笔记”的区别是:
- 发布博客文章:写入
source/_posts/ - 发布文档页面:写入
docs-site/docs/
这样你写随笔时走博客,写教程或项目说明时走文档。