夫『文心』者,言为文之用心也,文果载心,余心有寄。『雕龙』者,振叶以寻根,观澜而索源。心定而后结音,理正而后摛藻,使文不灭质,博不溺心,正采耀乎朱蓝,间色屏于红紫,乃可谓雕琢其章,彬彬君子矣。
何谓『文心雕龙』?以上作解。
Gitbook 是一个非常适合个人的笔记平台,配合 vscode 双剑合璧,所向披靡,是咱目前首选的写作方式。
除了优秀的写作平台,写作规范也很重要,作为完美主义和强迫症晚期患者,遵循严格的写作标准,对文章创作亦大有裨益。可能没有足够的词藻堆砌斐然的文章,但用严格的标准来约束文章的结构规范亦不失是一种补救,『文心雕龙』,即为此意。
写作规范
写作规范即指标题、文本、段落、中英文、标点符号、参考链接等等格式规范。吾常观各大博客,文章格式杂乱者不在少数,中英文切换不留空格、符号混用、多级标题随心所欲,笔走龙蛇,各自有文风。
「有研究显示,打字的时候不喜欢在中文和英文之间加空格的人,感情路都走得很辛苦,有七成的比例会在 34 岁的时候跟自己不爱的人结婚,而其余三成的人最后只能把遗产留给自己的猫。毕竟爱情跟书写都需要适时地留白。与大家共勉之。」——vinta/paranoid-auto-spacing
在写作过程中,咱主要参考的是以下两个规范,其一是写作规范,其二是格式规范,其三为排版规范,三篇规范各有杂述。
遵循上述写作规范,日常博文写作更加如鱼得水。
写作工具
再推荐下咱当前所用的写作工具:vscode + markdownlint
vscode 支持 Markdown 写作预览,是一个不错的文本编辑器,但类似开源软件不在少数,为何偏偏青睐 vscode,其重点是后面它独有的 markdownlint 扩展。
markdownlint 官方介绍:
Markdown/CommonMark linting and style checking for Visual Studio Code.
顾名思义,markdownlint 是一个 Markdown 语法检测与修复的 vscode 小扩展。它能修复错误语法,规范写作风格,统一写作范式,是处女座或有洁癖作者的必备工具。正是因为这个扩展让咱放弃诸多如 typora 等知名工具。
该扩展提供 40 多种 Markdown 最佳写作规范来让写作更加轻松和愉悦。这里简要摘取 5 条写作规范:
- MD001 heading-increment/header-increment - Heading levels should only increment by one level at a time
- MD002 first-heading-h1/first-header-h1 - First heading should be a top level heading~~
- MD003 heading-style/header-style - Heading style
- MD004 ul-style - Unordered list style
- MD005 list-indent - Inconsistent indentation for list items at the same level
该扩展的所有 Markdown 规范详见 markdownlint/doc/Rules.md
Just enjoy it!
一种优雅的笔记方式
做笔记真是件麻烦的事,特别是对于我这种 CV 工程师来说,之前看过不少推荐笔记工具的文章和帖子,所以特想安利一下自己花了不少时间摸索出来的一种简单优雅与高效的笔记方式。
自己尝试用过 Typora、Notion、OneNote、Obsidian、Github issues 等几种方式,最后还是发现这种方式用得最舒服。自己最终放弃上述几种笔记工具是因为它们或多或少总是有些自己不能忍受的缺失点:
- Typora:没有 md 语法检查和格式化,完美主义者很难受;
- Notion:除了需要付费外,它不是标准的 md 语法(我对 md 情有独钟);
- OneNote:不支持 md,不适合贴代码,太过自由,不适合我这种没有大局观的人,还是 md 适合我;
- Obsidian: 过于折腾,不喜欢;
- Github issues:这种方式做笔记太累了,没有目录层级,阅读体验不太行,我主要把它当作自定义博客数据源;
其他的几种笔记方式包括有道云笔记、为知笔记等等都有上面几种缺点(对我来说),它们都未能解决我的痛点:
- 支持 md 语法检查和格式化(我对 md 情有独钟)
- 支持全局搜索
- 支持分类目录
- 良好的阅读体验,方便查阅
- 优雅的同步备份方式
直到我发现了 gitbook,发现才是最简单适合我的笔记方式,配合 vscode 简直完美,自己已经成功安利了几个同事使用,用过了都说好。
- vscode + markdownlint 插件,支持 md 语法检查和格式化。
- github + gitbook 自动同步,本地笔记推送到 github,可以自动同步到 gitbook,支持全局搜索与层级目录。
它完美解决了上面我的几个痛点:
- 支持 md 语法检查和格式化
- 支持全局搜索
- 支持分类目录
- gitbook 自动同步
- 完美的阅读体验,高效复习和查阅
- 甚至可以绑定域名当博客使用
