Markdown 如何更好的显示日志、提示、警告、错误等消息?
Markdown 官方似乎都没有给出相应的规范。网上也很少有人讨论这些。
Github 使用 Linguist 执行语言检测和语法高亮。我在 Linguist 规范中似乎没有找到答案。于是创建了一个讨论 What is the preferred way to include error messages in Markdown? · Discussion #5927 · github/linguist,期待能得到答案。
与 Linguist 同类的是 highlight.js,但是 highlight.js 上也没有找到用于显示日志、提示、警告、错误等消息的语法高亮。
于是我创建了一些 示例,然后将其放在 GitHub 上,通过对代码块使用不同语言渲染后的效果,我的建议是,使用 markdown
语言标识符仅高亮 Markdown 语法,或者不要添加任何语言标识符,不进行语法高亮显示,因为似乎没有一种语言标识符能满足,杂乱的高亮反而影响阅读。
StackExchange 上也有说用引用,但是引用不会自动换行,它和无语法的文本一样,在 Markdown 中普通换行是不会换行的。没有换行阅读起来更累,因为用引用肯定是不行的。
当然最好的方案就是 Linguist 使用 Jetbrains IDE 使用的语法高亮。你看他们家的 IDE 对输出的信息显示得多好。