Magnolia Docs

Documentation for Magnolia Financial's web-based Bitcoin APIs

Live documentation: https://docs.magnolia.financial/

Built with Docusaurus.

Local Development

Install npm and yarn.

yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

OpenAPI Documentation

API docs are autogenerated using docusaurus-openapi-docs from OpenAPI specs found in openapi/ and are output to docs/api/endpoints.

With yarn start running, the openapi/ directory is monitored for changes, and should automatically update docs/api/endpoints.

To manually regenerate the API docs, run yarn gen-api-docs all.