炒作-一个用Go编写的Markdown文档编译器

“Hype” 是一个强大的文档编译器和生成器,基于我们都熟悉的 Markdown 语法(当然,是用 Go 语言编写的)!

Hype 可以:

  • 包含部分内容 — 这使您可以创建模块化的技术文档并重复使用它。像编写和维护代码库一样编写和维护技术文档!
  • 轻松包含代码示例
  • 验证正确的语法 — 再也不会包含过时的代码示例!
  • 包含代码示例的输出
  • 包含代码“部分”(我们称之为片段)以突出特定的部分。 通过使用Hugo,您可以在文档中直接包含来自您的私人存储库的“godoc”(无需多次编写该函数文档)。您可以执行任意shell命令,并将其包含在文档中。您可以指定代码和命令执行的退出代码,允许在文档中包含“错误”语法和命令。您可以验证图像或引用的资产是否存在。您可以使用GitHub操作根据文档资产自动编译您的README。这确保您的自述文件始终具有代码示例等的最新版本。查看这里的示例。