docbox - REST API documentation generator

  •        365

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.


babel-cli : ^6.4.0
babel-eslint : ^8.0.0
babel-plugin-transform-class-properties : ^6.24.1
babel-polyfill : ^6.3.14
babel-preset-es2015 : ^6.3.13
babel-preset-react : ^6.3.13
babel-preset-stage-0 : ^6.3.13
babelify : ^8.0.0
brfs : ^1.4.2
browserify : ^15.0.0
cssnano : ^3.4.0
es6-promise : ^4.1.0
eslint : ^4.1.0
eslint-plugin-babel : ^4.1.1
eslint-plugin-react : ^7.0.0
github-slugger : ^1.0.1
highlight.js : ^9.2.0
isomorphic-fetch : ^2.2.0
lodash.debounce : ^4.0.3
minifyify : ^7.1.0
prop-types : ^15.5.9
react : ^16.1.1
react-dom : ^16.1.1
remark : ^8.0.0
remark-html : ^7.0.0
remark-slug : ^5.0.0
standard-changelog : ^1.0.1
standard-version : ^4.0.0
unist-util-select : ^1.3.0
unist-util-visit : ^1.0.0



Related Projects

swagger2markup - A Swagger to AsciiDoc or Markdown converter to simplify the generation of an up-to-date RESTful API documentation by combining documentation that’s been hand-written with auto-generated API documentation

  •    Java

The primary goal of this project is to simplify the generation of an up-to-date RESTful API documentation by combining documentation that’s been hand-written with auto-generated API documentation produced by Swagger. The result is intended to be an up-to-date, easy-to-read, on- and offline user guide, comparable to GitHub’s API documentation. The output of Swagger2Markup can be used as an alternative to swagger-ui and can be served as static content. NOTE: The Swagger Specification has been donated to to the Open API Initiative (OAI) and has been renamed to the OpenAPI Specification. Swagger2Markup converts a Swagger JSON or YAML file into several AsciiDoc or GitHub Flavored Markdown documents which can be combined with hand-written documentation. The Swagger source file can be located locally or remotely via HTTP. Swagger2Markup supports the Swagger 1.2 and 2.0 specification. Internally it uses the official swagger-parser and my markup-document-builder.

JSDoc - An API documentation generator for JavaScript

  •    Javascript

JSDoc 3 is an API documentation generator for JavaScript, similar to Javadoc or phpDocumentor. You add documentation comments directly to your source code, right alongside the code itself. The JSDoc tool will scan your source code and generate an HTML documentation website for you.

apidoc - RESTful web API Documentation Generator.

  •    Javascript

Generates a RESTful web API Documentation.apiDoc creates a documentation from API descriptions in your source code. It has support of API history, with that various API version levels can be compared.So it can be retraced what changed in the API since the last version.

abao - REST API automated testing tool based on RAML

  •    CoffeeScript

Abao is a command-line tool for testing API documentation written in RAML format against its back-end implementation. With Abao, you can easily plug your API documentation into a Continuous Integration (CI) system (e.g., Travis, Jenkins) and have API documentation up-to-date, all the time. Abao uses Mocha for judging if a particular API response is valid or not. This version of the software only supports the RAML-0.8 specification.

SLATE - Beautiful static documentation for your API

  •    Javascript

Slate helps you create beautiful, intelligent, responsive API documentation. Slate is responsive, so it looks great on tablets, phones, and even in print. The description of your API is on the left side of your documentation, and all the code examples are on the right side. It supports Syntax highlighting, Markdown, RTL support and lot more.

grape-swagger - Add OAPI/swagger v2.0 compliant documentation to your grape API

  •    Ruby

The grape-swagger gem provides an autogenerated documentation for your Grape API. The generated documentation is Swagger-compliant, meaning it can easily be discovered in Swagger UI. You should be able to point the petstore demo to your API. This screenshot is based on the Hussars sample app.

DevDocs - API Documentation Browser

  •    Ruby

DevDocs combines multiple API documentations in a fast, organized, and searchable interface.Unless you wish to contribute to the project, I recommend using the hosted version at It's up-to-date and works offline out-of-the-box.

yuidoc - YUI Javascript Documentation Tool

  •    HTML

YUI's JavaScript Documentation engine. YUIDoc is a Node.js application used at build time to generate API documentation for JavaScript code. YUIDoc is comment-driven and supports a wide range of JavaScript coding styles. The output of YUIDoc is API documentation formatted as a set of HTML pages including information about methods, properties, custom events and inheritance for JavaScript objects.

office-js-docs - Microsoft Office Add-ins API Reference Documentation

  •    Batchfile

Welcome to the Office JavaScript API Reference documentation. In this repository, you can find the documentation source files for Office JavaScript API Reference. For the best experience, we recommend you view this content on Office Developer Center.Additionally, the branches within this repository contain Open Specifications for host-specific JavaScript APIs such as the Excel JavaScript API and Word JavaScript API.

api-console - A Web Component for an interactive REST console based on RAML files

  •    HTML

See live example of the API console in our demo application. MuleSoft's API Console is a full-fledged API documentation tool that generates mobile-friendly web documentation based on RAML (Restful API Modeling Language) documents. In addition to providing documentation, the tool provides the capability for users to try out requests on the fly.

swagger - Swagger client generator

  •    Javascript

This is a utility for automatically generating API documentation from annotations in Go code. It generates the documentation as JSON, according to the Swagger Spec, and then displays it using Swagger UI.This tool was inspired by Beego, and follows the same annotation standards set by Beego. The main difference between this tool and Beego is that this generator doesn't depend on the Beego framework. You can use any framework to implement your API (or don't use a framework at all). You just add declarative comments to your API controllers, then run this generator and your documentation is ready! For an example of what such documentation looks like when presented via Swagger UI, see the Swagger pet store example.

devdocs - API Documentation Browser

  •    Ruby

DevDocs combines multiple API documentations in a fast, organized, and searchable interface. Unless you wish to contribute to the project, I recommend using the hosted version at It's up-to-date and works offline out-of-the-box.

discord-api-docs - Official Discord API Documentation

  •    Javascript

This repo contains the official Discord API documentation, which can be viewed online HERE. Before submitting pull-requests, please remember to fully read the Contributing guidelines. This repository uses special markdown syntax that helps style the resulting web version of the documentation.

markdoc - A lightweight Markdown-based wiki system. Current status: abandoned.

  •    Python

Markdoc is a lightweight Markdown-based wiki system. It’s been designed to allow you to create and manage wikis as quickly and easily as possible. Technical Documentation/Manuals Markdoc can be used to write and render hand-written guides and manuals for software. Such documentation will normally be separate from automatically-generated API documentation, and might give a higher-level view than API docs alone. It might be used for client documentation for web/desktop applications, or even developer documentation for frameworks.

api-documentation - This is the 500px API documentation.

  •    Ruby

This is the 500px API documentation.

docfx - Tools for building and publishing API documentation for .NET projects

  •    CSharp

DocFX makes it extremely easy to generate your developer hub with API reference, landing page, and how-to.We currently support C# and VB projects.

We have large collection of open source products. Follow the tags from Tag Cloud >>

Open source products are scattered around the web. Please provide information about the open source projects you own / you use. Add Projects.