InkMark，全新设计的一种轻量级的标记语言

去年 6 月的时候，我在这里说准备设计一种轻量级标记语言，当时反响一般，我想主要原因是那时我自己都还没有把要做的事情完全想明白。一晃一年多时间都过去了，终于写出这个标记语言的初稿，并将它叫做 InkMark。

相对于其他各种轻量级标记语言，InkMark 具有以下特性：

具有几乎与 HTML 相匹配的文档内容描述能力。理论上来说，InkMark 可以表示 HTML 中所有类型的元素，以及为元素添加任意属性。
很好地在简单和功能强大之间取得平衡。InkMark 的元素标记法包括完整模式和简写模式，其完整模式像 HTML 一样功能强大，而简写模式则像 Markdown 一样简单，且可以按统一的规则由完整模式过渡到简写模式。
简写模式使用独特的“标记符号加方括号对接龙”形式的语法。例如，在其他轻量级标记语言中，常用 **着重强调** 表示要 着重强调 的文本，Inkmark 中却使用 *[着重强调] 达到同样的效果。
能够用于科学技术报告、学术论文、书籍的书写。通常这些学术文档篇幅巨大，结构复杂，含有大量的图像、表格、公式和参考文献，需要对这些内容标注题注、自动编号，并在文档其他位置进行交叉引用和索引。
具有灵活的文档组织能力。各个文档可独立编写和呈现，之后不必改变就可以合并在一起形成更长的主文档。无论是论坛帖子、博客文章、期刊论文、报告或书籍，其书写体验基本一致。
注重语义的表述，不直接指定显示格式。如该语言关心你文本中的一行文字是普通段落、标题还是引文，但却不关心你的段落对齐方式，以及首行是否缩进等。
尽可能保持语法的一致性和对称性。使用户能根据一定的规则来理解和学习其语法，避免产生歧义，降低语法学习和解析器实现的难度。
良好的中文支持。其语法在换行、空格及标点处理，东西方文字混排等方面都更符合中文用户的使用习惯。
当使用相对高级的功能时，所生成 HTML 文本的正确显示需要依赖特定的层叠样式表（ CSS ）甚至 JavaScript 代码。如通常要借助 MathJax 这类 JavaScript 数学显示引擎才能正确地显示文档中的公式，带编号公式的合理显示布局（通常公式和编号显示在同一行内，公式居中对齐，编号右对齐）也需要借助额外的 CSS 实现，而一些自定义类独有的显示方式也需要借助 CSS 实现。
更加复杂。功能强大必然带来复杂性的提升，因此针对其全部功能的学习及解析器的实现将非常困难。InkMark 的复杂性主要表现于两种元素标记模式的融合共存，自动编号、引用、索引相关功能的实现，以及灵活的文档组织。

InkMark 不像 Markdown 几乎为每种常用元素定义了简单且直观的标记方法，它很“死板”，几乎是为所有元素定义了相同的标记规则。因此 InkMark 不如 Markdown 那么直观，也不如 Markdown 那样特别适合编写程序开发文档。但 InkMark 的标记规则相对更容易学习，并且其表达能力要强得多。其元素内容的边界范围也更加明确，不容易产生歧义。当只使用常用的标记功能时，它几乎和 Markdown 一样简单。

和 HTML 相比，InkMark 的完整模式几乎具有和 HTML 相匹配的描述能力，但元素边界不如 HTML 那样通过起始和结束标签项明晰标示。而 InkMark 的简写模式则要比 HTML 简单得多，适合手工书写，且源代码也更易读。InkMark 能做到在完整模式和简单模式间无缝切换，很好地在简单和功能强大间取得了平衡；不过两者进行切换的规则需要额外的学习成本。另外，针对学术文档的书写这一特殊目的，InkMark 通过加入一些自定义元素大大增强了其表达能力。

相对于 LaTeX 这种专业的学术论文排版系统，InkMark 主要专注于为文本添加常用的结构和语义，而其他更多的功能，如文本和页面样式，则大多交给其他程序（如和网页关联的层叠样式表 CSS ）来完成。因此，其功能要远远少于 LaTeX，但也简单得多。

目前我只是用 HTML 格式写了一个长长的文档，真的是很长很长的一个文档，干这个事的难度比我预想的大多了。暂时先把这个文档发布在我的博客上：

InkMark：一种轻量级的标记语言

这么长的文档，里面肯定有表述错误，请大家不吝指出！

我自己没有精力编写该语言的解析器，我只是先把这个文档放出来，看看大家的反馈。如果反响不错，将会进一步投入精力，并希望能有更多的人参与这项工作。

期待大家的讨论，谢谢！

namelosw

2021-08-25 21:00:24 +08:00

@chingli 我能理解你的这个定位。LaTeX 重得有点没必要，Markdown 有时候不太够用。

Markup 主要分两种，一种是偏读写的，一种是偏结构的。

Markdown 的问题：
1. 偏读写：缺少结构，我看你主要靠 [] 嵌套解决这个问题。
2. 不太够用：应该提高扩展性而非功能，我看你有类似 directive 一样的东西来增加扩展性。

不过有个问题是全靠 <></> 或者 [] () 之类的的元素，就会写起来比较不爽。如果觉得不会不爽的话，其实 LISP 就已经是最好的 Markup 了。如果像 Markdown 一样不靠 [] () 嵌套，一方面表现力下降，另外一方面需要减少符号，比如 & 很常用，如果作为特殊符号就要经常转义。个人感觉缩进可能是一个比较好的折中方案，只是不知道非程序员是不是很容易把缩进搞混（虽然很多人抱怨缩进，但是我就没见过 Python 程序员日常会把缩进搞混的）。

我看你好像不是 IT 人员，可以推荐几个值得参考的 markup （ just in case 你没看到这几个竞品）：

1. Jade：一个模板语言，更像 HTML，用的缩进形式。https://jade-lang.com/

2. reStructuredText：Python 社区很常用，主观感受流行度可能仅次于 Markdown 。https://docutils.sourceforge.io/rst.html

3. Org Mode：Emacs 内置的 markup，用户很多，扩展也很多，除了当 markup 之外更多做 GTD，日程管理，有时候还会当简单的 Excel 用等等。GitHub 除了支持 Markdown 之外其实也支持 Org 。https://orgmode.org/

4. Scribble：Racket 社区的通用 markup，本质上是 Racket 的一个库 /语言，因为是 LISP 所以扩展性很强。https://docs.racket-lang.org/scribble/

5. MDX：这个不太算 markup，本质上是一个 Markdown + JSX 预处理器，但是这样其实就相当于 Markdown + React，那么威力一下就提高了。不过 Markdown 和 JSX 之间其实结合的并不好，很多时候从 JSX 里面套回 Markdown 虽然可行但很别扭（不过这个是 Markdown 的问题，用了 HTML 里面就不能再用 Markdown 了）。https://mdxjs.com/

chingli

2021-08-26 09:06:18 +08:00

@namelosw 你都说到点子上了。我设计的这个东西的确解决了你所说的 Markdown 的两个问题，但太多的方括号使其看起来有点丑陋。

我现在只是部分解决了方括号过多导致丑陋的问题，就是规定若块级元素只占一行时，可以不写方括号。另外，当列表项元素包含多个段落时，也可以通过使用斜线表示的接力棒 / 标记而不使用方括号。

虽然用方括号很丑陋，但是针对我想解决的问题，我找不出更好的方法。比如，学术文档中往往一个表格单元格内还包括多个段落，我找不出除了用括号外能更好地包括这多个段落的方法。另外，我也找不出不使用括号而给元素添加属性的好方法——为元素添加属性在实现复杂的功能时真的很有用。用括号还有一个好处，就是元素内容的边界清晰，学术内容可能包含各种标点符号，像常规的用 *强调* 形式的标记方法，很可能和内容中的乘号相混淆。

Markdown 中的缩进规则是比较复杂的，我觉得除了程序开发人员，其他人员对多少个空格根本不敏感。我常常给学生们改 Word 论文，其中存在太多的胡乱用空格的情况。甚至好多时候，文档中多出一些空格他们都会视而不见。因此，我从最初的设计时，就排除了利用行首和行尾水平空白作为标记的方式，即完全忽略标记内容开始和结尾的空白。

我也看了许多已有的标记语言（但没有全部看完），都不如 Markdown 那样简单明了。大多数标记语言大都针对每个元素类型设计了独特的标记规则，标记方法太多，不好记忆，在 InkMark 中也不够用。我这里力求规则一致。但这个文档看起来仍然复杂，主要是因为自动编号元素有点复杂了（其中的 number 和 template 属性看起来有点像模板语言），以及对属性的支持使得格式有点凌乱。

另外，我在设计时，也并不是一直想着要简单。因为复杂的问题往往必然只能有复杂的解决方法。看看 MediaWiki 的标记语法，虽然基本语法比较简单，但完全不够用，必须配合使用 HTML 以及模板，大多数维基页面都充斥着这些复杂的混合标记。所以我不如一开始就把一些功能设计得稍微复杂一点，可扩展性强一点。当然，我现暂时在还不敢往里面加模板功能，那样就太复杂了。

对于非编程开发人员，我现在第一担心的是他们能不能分清行内元素和块级元素，而我设计的这个标记语法在进行标记时，必须首先能区分这两类元素。