富文本编辑器与 md 语法的一些困惑
在语雀写文档写得多的,会对原始的 Markdown 越来越不敏感。
语雀的富文本编辑器虽然支持的依然是 markdown,但也有它自身的一些与传统 markdown 不一样的写法,例如 高亮块。这样的编辑器把 markdown 的源码给隐藏了——在用户编辑的时候实时进行渲染,这样对于不熟悉 markdown 的用户也极容易上手。
但带来了一个问题,就是使用 markdown 对文档进行导出的时候,有时候会导致 markdown 格式错乱,尤其是当我们想要把语雀的一些文档导出到其他平台时候,这个问题特别烦人。
回到 GitHub,重新接触纯 Markdown 格式的写法,才真正感觉到这种模式的好处 —— 方便其他支持 Markdown 语法平台的转移,又可以最大限度解决 Markdown 语法错乱的尴尬。
但也有不好的地方,就是对于多级有序缩进,插入代码后,有序序列(多级缩进)会被打断。。。。
嵌套列表¶
通过增加空格,Github 可以实现在嵌套列表中插入代码块;但是这样的做法在 MkDocs 中是有问题的。关于 MkDocs 的嵌套列表,在 https://github.com/mkdocs/mkdocs/issues/545 有一个讨论。
参考的一个方法:https://github.com/mkdocs/mkdocs/issues/2153,即使用 superfences 插件,加上基于 Python 特有的 4 的倍数个空格进行缩进,可以比较好解决这个问题。