Shrimple – 更简单、更好的 Markdown

Shrimple 是一个更好、更干净的 Markdown 替代品。得到它 。这是一个虾仁文档。它的编写方式使其无论作为文本文档还是呈现为 HTML 时都看起来干净且可读。安装和使用你需要一个 Go 编译器来首先编译它： go build 然后像这样运行它： cat README | ./shrimple -s -w > README.html -s 或 --default-css 标志将默认 css 添加到 HTML 输出，而 -w 或 --wrap 标志将页面包装在 HTML 中以形成完整的文档。如果您希望以某种方式生成输出并插入到您自己的网站中，那么您将不需要这些标签。要查看所有可用选项，请输入： ./shrimple --help 链接和脚注 链接也设计得很干净。我们不使用内联 URL 来污染源文档（这可能很长并且会扰乱可读性），而是使用非常虾米的内容！想法：链接从它所引用的脚注中获取其 URL。当然，您也可以添加常规脚注 1 ，在这种情况下，单词旁边带有数字的小链接将引导您进入脚注部分。代码 让我们从代码块开始。看下面的例子：即使两个 if 块之间有一个空行，它仍然是一个单一的代码块： if err != nil { return -1 } if err == nil { return 1 } 代码块必须缩进 6 个空格，在渲染时，这些空格将被修剪，但前 6 个空格之后的额外空格将被保留。以 ### Go 开头的代码块的第一行是可选的，但它向代码块标记添加了一个 HTML 类，当与 Prism.js 代码荧光笔一起使用时，将导致特定语言的正确代码突出显示。我们还可以有内联代码，例如 fmt.Println("this is inline code") Lists Shrimple 还允许您创建编号列表和项目符号列表。例如，下面是一个带有项目符号点的列表： 列表必须向右缩进两个空格 每个项目可以或不可以用空行与前一项分隔。如果列表项很长，您可以轻松地将内容放在下一行。在这种情况下，后续行必须缩进 4 个空格才能与第一行对齐。编号列表非常相似：缩进是相同的——两个空格。后续项目可以正常编号（与 Markdown 不同，它们都必须为“1”）。任何给定编号列表项中的后续行必须通过句点字符“.”对齐。在第一行。数字不一定是连续的，但它们将被标准化为连续的。它只是有效！两种类型的标题 标题允许有两种级别类型：“h1”和“h2”。级别由下划线的“粗细”决定，其中 === 代表“h1”，--- 代表“h2”。关于标题的一件重要的事情是：无论何时，实际标题后面的行必须始终至少有 3 个字符长（这是硬编码规则），否则上面的行将不会呈现为标题。注释以一行开头，该行由一个大写单词（无空格）组成，后面可选地跟随任何标点符号 - 在本例中为“：”。以下行必须缩进 4 个空格。这个词不一定是“NOTES”，也可以是“SIDENOTE”或“ATTENTION”之类的东西。该单词本身将被小写并在输出中用作 html 标签 css 类。注释也可以包含空行（没有缩进），但空行必须被属于该注释的非空行包围（因此，缩进 4 个空格）才能被视为注释的一部分。解析和渲染字典 这是 Shrimple 最强大的功能之一。您不必用各种奇怪的字符或 HTML 污染您的原始文档，您只需编写文本，当需要突出显示某些特定单词或表达式时，您可以使用解析和渲染字典来定义它。查看存储库根目录中的两个文件：parse_dict 和 render_dict，然后查看下一段中的示例： 本段是解析和渲染字典的示例。请注意，word1 和 word2 带下划线，word3 和其中包含空格的表达式为绿色。但在 Shrimple 源文档中没有对这些单词进行任何额外标记。它们只是根据解析和渲染字典来选取的。要指示 Shrimple 使用解析和渲染字典，请使用 -p 和 -r cli 参数（“p”表示解析，“r”表示渲染）： ./shrimple ... -p path/to/parse_dict -r path/to/render_dict 生成静态网站 Shrimple 始终的目标之一是能够生成文档页面。 Shrimple 的静态站点生成器使这成为可能。它将获取一个源文件目录（以 Shrimple 格式编写），将每个文件转换为 HTML 文档并将其全部输出到另一个目录中。每个页面都可以选择在底部包含一个菜单和上一个/下一个导航链接。让我们看看它是如何工作的。假设你