博客和文档的分工¶
你的站点现在可以拆成两个互相连接的区域。
Hexo 负责博客¶
Hexo 更适合这些内容:
- 日常文章
- 学习记录
- 标签和分类
- 首页展示
- 按时间归档的内容
线上地址:
https://smashxx00.github.io/blog/
MkDocs 负责文档¶
MkDocs 更适合这些内容:
- 项目说明书
- 使用教程
- 部署步骤
- 系统设计文档
- 可以长期维护的知识库
线上地址:
https://smashxx00.github.io/blog/docs/
为什么不把文档也塞进博客文章¶
博客文章是按时间阅读的,文档是按结构阅读的。
如果把所有内容都塞进博客,后面会出现三个问题:
- 教程会被新文章冲下去。
- 同一个项目的说明会散在很多日期里。
- 读者很难按章节连续阅读。
所以更清楚的做法是:
flowchart TD
A["内容"] --> B{"这篇内容更像什么?"}
B -->|"有时间感、像记录"| C["发到 Hexo 博客"]
B -->|"要长期维护、像说明书"| D["发到 MkDocs 文档"]
当前推荐规则¶
如果一篇内容标题像“我今天解决了什么问题”,放博客。
如果一篇内容标题像“某系统怎么安装、怎么使用、怎么维护”,放文档。