介绍「M↓漢」

MarkdownHan(风格化作「M↓漢」) 是Markdown的延伸,尝试为原有的Markdown语法增加行间注、增订和删订等中文和日文写作里常用的特性。你可以在这个网页里测试使用M↓漢。Read in English at its GitHub repository.

MarkdownHan(风格化作「M↓漢」) 是Markdown的又一个延伸,尝试为原有的Markdown语法增加了一些中文和日文写作里常用的特性。具体而言,M↓漢在John Gruber的Markdown基础上增加了写作中的行间注增订删订的语法。

你可以在这个网页里测试使用M↓漢

什么是Markdown?

Markdown是一个用纯文本来实现结构化写作的工具。它由John Gruber(在Aaron Swartz帮助下)开发,在2004年以其语法说明和一个实现纯文本向HTML转换进行Markdown转换的Perl脚本的形式问世。此后,Markdown被用许多语言实现,也渐渐被Reddit、StackOverflow、GitHub、Telegram等许多平台支持,被人们广泛使用。

为什么提出了M↓漢?

从互联网上许多关于中文书写系统的讨论中,我认识到当前很多写作字体排印工具都在支持中文需求上有很多欠缺,甚至认为当前互联网上中文的书写习惯也已经被来自西方的工具改变。陳奕鈞汉字标准格式字体排印上(网页)支援了许多特性。受这个项目的启示,我想到也许在写作也可以做些什么。因为自己写作最常用的Markdown对东亚文字写作常见的行间注没有支持——随后也读到了有人在日语写作中有这一需求——便想尝试为中文和日文的写作扩展一些Markdown语法。

M↓漢新增的语法

下面的表格说明了新增的三种语法。

名称 M↓漢语法示例 转换后的HTML示例
行间注 *:中文/zhōngwén/写作/xiězuò/:* <ruby>中文<rt>zhōngwén</rt>写作<rt>xiězuò</rt></ruby>
增订 中文_:写作:_ 中文<ins>写作</ins>
删订 中文~~写作~~ 中文<del>写作</del>

可以与其他Markdown语法搭配使用。仅作为一次尝试,故在此不提更多的规格说明。

类似于Markdown,M↓漢除了是一种语法以外,也被实现成了一个按照M↓漢的语法将纯文本转换成HTML的Javascript程序。这个演示使用这段程序来展示了效果。

开发

M↓漢的程序在Marked的基础上开发。Marked是一个开源的、Javascript编写的Markdown解析器。

M↓漢的开发通过了Marked工程里的原有的所有测试。但没有为新的语法新增新的测试——也许复杂情况下仍然存在问题,但希望还是可以用的。

License

Copyright for portions of project MarkdownHan are held by Christopher Jeffrey as part of project Marked. All other copyright for project MarkdownHan are held by Zhen Fan, 2020. (MIT License)