不少大佬都会使用 GitBook, Vuepress, Jekyll 等工具来构建属于自己的技术文档,然后我在想最纯粹的方式不是直接沿用 GitHub Pages 吗?
所以我就写了个模板 markdown-only 沿用 GitHub Pages 内置的 GFM 及 Jekyll 来支持最纯粹的构建并直接套上 GitHub 沿用的样式来支持 dark mode 的显示。这样一来,维护+构建+发布都完全给傻瓜化了,各位大佬不就能更专注于自己写的干货和鸡汤( bi ji )吗?

不少大佬都会使用 GitBook, Vuepress, Jekyll 等工具来构建属于自己的技术文档,然后我在想最纯粹的方式不是直接沿用 GitHub Pages 吗?
所以我就写了个模板 markdown-only 沿用 GitHub Pages 内置的 GFM 及 Jekyll 来支持最纯粹的构建并直接套上 GitHub 沿用的样式来支持 dark mode 的显示。这样一来,维护+构建+发布都完全给傻瓜化了,各位大佬不就能更专注于自己写的干货和鸡汤( bi ji )吗?
1 codehz Mar 20, 2021 via Android 最纯的方法:用 HTML 写 HTML,用 PostScript 写 pdf |
3 JerryCha Mar 20, 2021 想了想,Lamy 可能还不够纯粹 三菱 ub150 + 晨光 B5 活页本 |
4 codehz Mar 20, 2021 via Android @aleen42 抖个机灵而已,不用在意。想到一年前有个 hn 大火的文章说好多开发者写博客最后都变成写新的静态网站生成器去了(折腾主题也算吧) 话说回来 Markdown 确实有很多局限性,虽然看起来过得去,但是真遇到点需求还得内嵌 html (然后大部分标签又会被 GFM 过滤),要说最纯粹,那肯定是省去这些中间步骤,一步到位直接写生成文件来的纯粹 |
5 cassyfar Mar 20, 2021 Code is self-explainatory. Why do you need any documentation? |
8 henryhu Mar 20, 2021 我在改造 Hexo,让发布流程更加自动化 |
9 hantsy Mar 20, 2021 我十几年前开始用 Docbook, Docbook 组织文档真的专业。 现在 Markdown 居多,一般代码为主文档也简单。也在熟悉 Asciidoc,用得少。 如果觉得 Markdown 有局限性,应该试一下 Asciidoc,出版级别的支持。 目前我熟悉的很多开源项目都是用 Asciidoc 。Spring 还有相关的开源项目,美化 HTML 页面。https://github.com/spring-io/spring-doc-resources/ |
12 ClericPy Mar 20, 2021 技术文档... 还真问住了, 之前体验最好的貌似是 Dropbox 和自定义主题的 Github pages 或者 mkdocs (material), 其次是 readthedocs 不过后来不习惯了 比较不爽的几次尝试比如 Google Docs 的代码格式化, 语雀累觉不爱... 插眼看看其他人的推荐 |
13 hantsy Mar 21, 2021 @ClericPy 文档看哪些类型,Github Pages,MKDocs,Gitbook 更适应有组织性比较专业的文档(介绍一个项目,或者技术),可能只有程序员用得最多。 Google Docs,Office 在线这种就比较大众化,几乎上就是代替本地 office 。 |
14 ClericPy Mar 21, 2021 @hantsy 所以前东家的知识管理大部分都在 Google Docs 和 Dropbox 上, 协同编辑还是挺常见的, 最主要的是异步交流能节省太多时间成本了, 远超一切莫名其妙开会 |