使用 Github 记录笔记和搭建 blog

发表是最好的记忆

– 侯捷

动机

• 很多小细节记录了，之后免得重新再次 google ；
• 记录笔记是输入的过程，写笔记是输出的过程，从而实现对于知识的完全理解。
• 总体来说，中文社区的质量比英文的差很多，而且 CSDN 之类的毒瘤，鼓励抄袭盗版，搞中文社区更加是乌烟瘴气。改善这种情况，我认为每一个都从自己做起，尽量输出一些自己的原创内容。

搭建方法

之前也尝试将 blog 放到知乎或者简书上，但是这些平台和我的 github + vim 的笔记记录模式存在较大的冲突， 虽然可以获得不错的流量，但是最后还是放弃了。

而且之前还尝试过很多酷炫的框架，但是发现不够简洁，也都放弃了。 现在所有笔记都是放到上传到 Github 的一个仓库 中，这个页面也是其中一个文件生成的。 而配置只有两行:

title: Deep Dark Fantasy
theme: jekyll-theme-cayman

将仓库初始化为 blog

基础操作参考这里 : https://guides.github.com/features/pages/

• Github 提供了几个不错的主题，只需要在 docs/_config.yml 配置即可，我选择的是 : https://github.com/pages-themes/cayman
• 我建议将需要 docs/ 作为 blog 而不是整个仓库，如此，其他的位置都是草稿区，而 docs/ 中作为发布的

添加评论

在静态网站上存在各种方法添加评论，比如:

• gitalk

我使用的方案是 https://giscus.app/ , 按照其步骤，将其生成的代码粘贴到你的 blog 中，下面是我的例子:

<script src="https://giscus.app/client.js"
        data-repo="martins3/martins3.github.io"
        data-repo-id="MDEwOlJlcG9zaXRvcnkyOTc4MjA0MDg="
        data-category="Show and tell"
        data-category-id="MDE4OkRpc2N1c3Npb25DYXRlZ29yeTMyMDMzNjY4"
        data-mapping="pathname"
        data-reactions-enabled="1"
        data-emit-metadata="0"
        data-theme="light"
        data-lang="zh-CN"
        crossorigin="anonymous"
        async>
</script>

增加语法检查

使用 lint-md 和 pre-commit 来构建语法检查，在这个仓库中，有三个文件和这个功能相关:

• .pre-commit-config.yaml : git commit 指向执行检查
• language/bash/hook/lint-md.sh : 其中一项检查是执行这个脚本
• .lintmdrc.json : lint-md 的执行参数

订阅

虽然本 blog 使用的 jellky 的主题，但是因为极简的配置，无法集成 jekyll-feed

所以 Newsletter 来实现订阅:

https://martins3.substack.com

想法

谈谈自己对于写博客想法:

• blog 是一个人构建知识体系的过程。
• 写 blog 应该是系统的，深入的，而不是零散的，blog 不是笔记，而是思考过程的体现。在 blog 中应该存在互联网中之前没有的东西，不是告诉这个东西是什么，而是反映了你对于这件事情的思考和创新。
• 语文教育中一直忽视了基本的写作训练

本站所有文章转发 CSDN 将按侵权追究法律责任，其它情况随意。