This mono repository contains tools and helpers for API documentation generation.
- @microfleet/schema-tools - The core of the JsonSchema documentation generator. Resolves JsonSchema references with @microfleet/validation flavoured automatical id generation.
- @microfleet/schema2md - Renders schemas parsed and dereferenced by
@microfleet/schema-toolsintojson2mdcompatible format. - @microfleet/apidoc-plugin-json-schema - The
apidocplugin that helps to include JsonSchemas into your API documentation. - @microfleet/mdoc - CLI tool that wraps
apidoc-markdownwith own default template and additional helper to build links between JsonSchemas. Generates MD from apidoc data files.
- Clone this repository
yarn installyarn dev
See @microfleet/mdoc