Algolia风格的API文档

时间:2016-01-27 10:09:05

标签: documentation-generation algolia

我非常喜欢Algolia采用多种编程语言API文档的方式,例如: https://www.algolia.com/doc/javascript

是否有人知道他们使用什么技术来生成它?

1 个答案:

答案 0 :(得分:1)

我们正在使用的文档生成器目前是一个内部工具。我们可能会在某些时候开源,但这需要一些我们目前没有的额外工作时间。

它基本上是一个markdown文件,带有一些额外的语法:

  • 处理多种语言的代码块(然后自动选择好的代码块)
  • 根据当前语言处理条件
  • 处理标注
  • 处理按钮

然后在bootstrap的帮助下手工制作渲染。