https://github.com/microfleet/docgen
https://github.com/microfleet/docgen
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/microfleet/docgen
- Owner: microfleet
- Created: 2020-08-20T05:57:51.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-13T00:12:45.000Z (almost 2 years ago)
- Last Synced: 2025-02-22T02:05:52.849Z (about 1 year ago)
- Language: TypeScript
- Size: 1.52 MB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Microfleet JSON Schemas documentation generator
This mono repository contains tools and helpers for API documentation generation.
### Packages
* [@microfleet/schema-tools](./packages/schema-tools) - The core of the JsonSchema documentation generator. Resolves JsonSchema references with [@microfleet/validation](https://github.com/microfleet/validation) flavoured automatical id generation.
* [@microfleet/schema2md](./packages/schema2md) - Renders schemas parsed and dereferenced by `@microfleet/schema-tools` into `json2md` compatible format.
* [@microfleet/apidoc-plugin-json-schema](./packages/apidoc-plugin-json-schema) - The `apidoc` plugin that helps to include JsonSchemas into your API documentation.
* [@microfleet/mdoc](./packages/mdoc) - CLI tool that wraps `apidoc-markdown` with own default template and additional helper to build links between JsonSchemas. Generates MD from apidoc data files.
### Development
1. Clone this repository
2. `yarn install`
3. `yarn dev`
### Usage
See [@microfleet/mdoc](./packages/mdoc)