Introducing the OMG plugin

docusaurus-plugin-omg compiles OpenAPI Markdown Grammar into OpenAPI 3.1 whenever Docusaurus builds.

OMG keeps an API description close to ordinary technical writing and is much shorter than the equivalent raw YAML. The plugin runs the parser and compiler, writes a YAML or JSON specification into your static files, and watches the source during local development.

It deliberately stops there. There is no bundled renderer and no prescribed documentation theme. Feed the generated specification to Redoc, Swagger UI, docusaurus-plugin-openapi-docs, or your own tooling.

This site compiles its small todo API with the plugin. Compare the OMG source with the generated OpenAPI file, read the plugin docs, or find it on npm.