此前在Github上翻到了阮一峰老师关于中文技术文档的写作规范的仓库,发觉非常适合我这样的转行新人学习最基本的技术文档写法,所以整体摘录下来放置于此,以供随时查阅学习。
Obsidian 是一款十分好用的本地端 markdown 编辑器,可以用来快速产出技术及产品文档,但其语法对于刚接触 markdown 的小白来说却显得十分复杂,虽然帮助界面上有一份详细的语法介绍,但整个帮助界面网页结构十分臃肿复杂,无法快速在大量链接文本中中检索到需要的语法与代码实现,所以这里单独整理出一份 Obsidian 的常用语法表以供随时查阅。