Introduction
The documentation site is built entirely using Mintlify. Mintlify docs are rendered from MDX files and configurations. Mintlify works with a Github integration to constantly build an independent docs site based off your latest published repository. Documentation can be edited in raw MDX, or directly through the Mintlify dashboard (which stays in sync with your local Github repo). Mintlify is fast to setup and provides tonnes of features out-the-box without the need to pay for a subscription for the basic services. You can run the docs site only by running thepnpm run dev
command from a terminal within the docs
directory.
Docs structure
The docs root directory is structured as follows:Item | Description |
---|---|
api | Automatically generated files (except for Introduction.mdx) |
mint.json | Mintlify configuration object |
package.json | Scripts needed in the monorepo/for generating the API files |