docbox

An open-source generator for REST API documentation. It turns structured Markdown files into a two-column documentation site with navigation, permalinks and examples.

Share on XLicense: ISC

Overview

Docbox is an open-source system for writing REST API documentation. You write structured Markdown files, and it builds a two-column site with prose on the left, examples on the right, plus navigation and permalinks. It is a React application that parses Markdown with remark. The source files stay free of presentation code, and a build step prepares the site for publishing.

Key features

  • Turns structured Markdown into a two-column documentation site
  • Generates navigation and permalinks automatically
  • Test suite checks for broken links, invalid examples and structure problems
  • Extracts JavaScript examples from docs and lints them with eslint

Best for

Teams that want to keep API docs as plain Markdown and enforce consistency through automated checks.

Upstream
mapillary/docbox
Fork on GitHub
Guo-astro/docbox
Upstream stars
1
Category
Documents, media and content
License
ISC
Forked
2020-12-06
Sync status
In syncLast synced 2026-09-29