在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
开源软件名称:tmcw/docbox开源软件地址:https://github.com/tmcw/docbox开源编程语言:CSS 78.5%开源软件介绍:Docbox is an open source REST API documentation system. It takes structured Markdown files and generates a friendly two-column layout with navigation, permalinks, and examples. The documentation source files that Docbox uses are friendly for documentation authors and free of presentational code: it's Markdown. Docbox is a JavaScript application written with React. The core magic is thanks to the remark Markdown parser, which enables the layout: after parsing a file into an Abstract Syntax Tree, we can move examples to the right, prose to the left, and build the navigation system. It has a supercharged test suite. Our tests check for everything from broken links to invalid examples and structure problems: this way, the application is only concerned with output and you can proactively enforce consistency and correctness. We even extract JavaScript examples from documentation and test them with eslint When you're ready to ship, Docbox's Writing DocumentationDocumentation is written as Markdown files in the Testing-drivenDocbox's test suite is an integral part of the design: it's designed to catch any error that would produce invalid documentation and also designed to be extended with custom rules for your documentation standards. Remember to run CustomizationAll custom code - code that relates to brands and specifics of APIs - is in the DevelopmentWe care about the ease of writing documentation. Docbox comes with batteries included: after you Requirements
To run the site locally:
TestsTests cover both the source code of Docbox as well as the content in the To run tests:
DeploymentThe
Using docbox
FAQ & See AlsoProps to Tripit's Slate project, which served as the inspiration for Docbox's layout. We also maintain a list of similar projects. |
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
请发表评论