# mpociot/whiteboard

Simply write beautiful API documentation.

Repository: https://github.com/mpociot/whiteboard
Canonical: https://ross.abutalabs.com/products/whiteboard
Language: JavaScript
License: NOASSERTION
License Family: other
Last push: 2021-01-29T11:20:13+00:00

## Health v2 (maintenance only)
Score: 32/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 0, release rhythm 35, longevity 100
- inputs: {"age_days": 3872, "days_push": 2042, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases, no_license
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1226, forks 126 (observed 2026-08-28T04:04:03.224171+00:00)

## What it is
Whiteboard is a Node.js-based API documentation generator forked from Slate, letting you write docs in Markdown and render them as a beautiful static site. It removes Slate's Ruby dependency and can generate docs programmatically via its module API.

## Use cases
- generate api documentation from markdown
- slate alternative without ruby
- publish static api docs site
- build docs in ci pipeline
- convert existing slate docs to nodejs tooling

## When to choose
- you want Slate-style API docs but prefer Node.js over Ruby
- you need to generate documentation programmatically in a build process
- you already have Slate-compatible Markdown docs

## When to avoid
- you need actively maintained tooling with recent updates
- you want docs generated from code annotations rather than hand-written Markdown
- you need features beyond what Slate/Hexo provide

## Facets
- artifact type: application
- maturity: maintenance
- function: documentation, static-site-generator, markdown, api-documentation
- domain: documentation, apis, web-development, developer-tools
- platform: cross-platform, cli
- tags: api-docs, slate-fork, hexo, markdown-to-html, docs-generator, nodejs

## Member repositories
- mpociot/whiteboard (main) score 32

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:04:03.224171+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T06:15:20.684889+00:00, confidence not recorded.
  - readme: https://github.com/mpociot/whiteboard (fetched 2026-08-28T04:04:03.224171+00:00, sha 762f23c2a14e)
- Data as of 2026-08-30T08:39:29.467469+00:00.