Skip to content

前言

我真的需要一个博客吗？

答案是不需要。正经人谁写日记啊。

Alt text

其实，我更需要的是一个能随时随地线上查阅的文档库。这个文档库可以是笔记、博客、文档、手册、教程、书籍、论文、代码等等。这些文档可以是自己写的，也可以是收集的。这是本站的初衷。

为什么选择 GitHub Pages + MkDocs Material 打造文档库？

  1. 成本

    GitHub Pages 是一个免费的静态站点托管服务，而 MkDocs 是一个开源的静态站点生成器，两者结合，可以免费拥有一个静态网站。它的工作流程非常简单，只需要在本地编写 Markdown 文件，然后通过 MkDocs 生成静态网站，再将生成的静态网站推送到 GitHub Pages 上，即可完成网站的更新。这大大的节约了建站费用以及部署成本。

  2. 便捷

    • 网站搭建：MkDocs 基于 Python 语言环境，安装和使用都非常简单。而且 MkDocs 具有详细的文档以及庞大的用户群，可以轻松的找到解决方案。
    • 内容编写：网站的内容是由 Markdown 文件生成的，基于其优秀特性，使用 Markdown 撰写文本极为方便。我们掌握 Markdown 语法后，随便一个文本编辑器就可以随时随地可以开撸，亦无需手动排版。
    • 文本转移：Markdown 格式具有强大的兼容性，可以在不同的编辑器、文本、平台之间自由转移，也可以方便的转换为其他格式，如 PDF、Word 等。
    • 浏览查询：Markdown 是纯文本文件，也就是说网站的内容是静态文件生成的。因此浏览和查询网页内容对设备的要求很低，只要有浏览器就可以访问，速度也很快。同时，MkDocs 生成的网站的搜索功能也有着不错的体验。

  3. 隐私

    托管在 GitHub 上，内容不受国内监管，不容易被和谐。

So：

❌ 手机备忘录，OneNote 等传统笔记软件：不支持 Markdown，不方便笔记转移。

❌ 国内类 Notion 的笔记软件（Flowus、语雀、为知、飞书文档……）：收费，受国内监管，敏感资源和谐。

❌ Notion：收费，服务器在国外，加载速度慢。

❌ Obsidian、Typora：只适合本地访问，不方便随时随地访问（Obsidian联网功能需要氪金而 Typora 正式版需要收费）。

❌ Hexo、Docsify：只专注于文档的快速生成和快速展示，用不着 Hexo 的华丽主题和各种扩展，而 Docsify 采用实时渲染方式，对于大型文档来说，加载速度会慢一些。

❌ 部署在个人服务器：需要购买服务器，域名。访问速度受服务器性能影响。当服务器重装、更换时需要迁移数据。

✔️ Markdown + GitHub Pages + MkDocs Material YYDS！

（不确定，再看看）