Shrimple是一个更好、更干净的Markdown替代品。获取它。这是一个Shrimple文档。它的编写方式使得它在作为文本文档时看起来干净和可读，同时在渲染为HTML时也是如此。安装与使用您需要一个Go编译器来首先编译它：go build 然后像这样运行它：cat README | ./shrimple -s -w > README.html -s或--default-css标志会向HTML输出添加默认的CSS，而-w或--wrap标志会将页面包装在HTML中，形成完整的文档。如果您希望生成输出并以某种方式插入到自己的网站中，那么您不需要那些标签。要查看所有可用选项，请输入：./shrimple --help 所有链接和脚注也是为了保持外观干净。为了避免在源文档中使用内联URL（这些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") 列表Shrimple还允许您创建编号列表和项目符号列表。例如，这里有一个项目符号列表： 列表必须向右缩进两个空格 每个项目可以与前一个项目之间用空行分开，也可以不分开。如果一个列表项很长，您可以简单地将内容放在下一行。在这种情况下，后续行都必须缩进4个空格，以与第一行对齐。编号列表也非常类似： 缩进相同——两个空格。后续项目可以正常编号（与Markdown不同，所有项目都必须是“1”）。在任何给定的编号列表项中的后续行必须在第一行的句号字符“.”对齐。数字不必是连续的，但最终会被标准化为连续的。它就是有效的！两种类型的头部头部允许有两种级别："h1"和"h2"。级别由下划线的厚度决定，其中===代表"h1"，而---代表"h2"。关于头部的一个重要事项：实际头部之后的行，无论何时，必须至少长3个字符（这是硬编码的规则），否则上面的行将不会被渲染为头部。注释以一行由一个单词的大写字母（没有空格）开头，可选地后跟任何标点符号——在这种情况下是":"。随后的行必须缩进4个空格。这个单词不一定是"NOTES"，可以是"SIDENOTE"或"ATTENTION"这样的词。该词本身将被小写，并在输出中用作HTML标签的CSS类。注释中也可以包含空行（没有缩进），但空行必须被属于该注释的非空行包围（因此，最终缩进4个空格），才能被视为该注释的一部分。解析与渲染字典这是Shrimple最强大的功能之一。您只需编写文本，当需要突出显示特定单词或表达的某些出现时，可以使用解析与渲染字典来定义它。看看根目录中的两个文件：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文档，并将其全部输出到另一个目录。每个页面可选地在底部包含菜单和上下导航链接。让我们看看这是如何工作的。假设你