docbox:REST API文档生成器

时间:2024-05-02 13:17:52
【文件属性】:

文件名称:docbox:REST API文档生成器

文件大小:76KB

文件格式:ZIP

更新时间:2024-05-02 13:17:52

CSS

docbox Docbox是一个开源的REST API文档系统。 它采用结构化的Markdown文件,并生成带有导航,固定链接和示例的友好的两列布局。 Docbox使用的文档源文件对文档作者很友好,并且没有演示代码:Markdown。 Docbox是一个用React编写JavaScript应用程序。 核心神奇的是感谢降价解析器,这使得布局:解析文件到后,我们可以移动的例子向右,散文到左边,并建立了导航系统。 它具有增压的测试套件。 我们的测试检查从断开的链接到无效的示例和结构问题的所有内容:这样,应用程序仅关注输出,您可以主动实施一致性和正确性。 我们甚至从文档中提取JavaScript示例,并用对其进行 当您准备好发货时,Docbox的build任务会最小化JavaScript,并使用React的服务器渲染代码使文档可为搜索引擎编入索引,而无需使用JavaScript即可查看。 撰写


【文件预览】:
docbox-master
----css()
--------icon.eot(29KB)
--------icon.woff(28KB)
--------base.css(89KB)
--------railscasts.css(1KB)
--------style.css(2KB)
----.eslintrc(1KB)
----index.html.sample(513B)
----.babelrc(127B)
----content()
--------example.md(7KB)
--------introduction.md(270B)
----package.json(2KB)
----test()
--------content.js(4KB)
----LICENSE(745B)
----CONTRIBUTING.md(4KB)
----src()
--------highlight.js(1KB)
--------index.js(385B)
--------custom()
--------render.js(811B)
--------components()
----.gitignore(26B)
----circle.yml(172B)
----CHANGELOG.md(4KB)
----CODE_OF_CONDUCT.md(3KB)
----README.md(5KB)

网友评论