Mintlify Starter Kit

Click on Use this template to copy the Mintlify starter kit. The starter kit contains examples including

• Guide pages
• Navigation
• Customizations
• API Reference pages
• Use of popular components

Contributing

• screenshots can be done on Mac via Ctrl+Shift+4+Spacebar and selecting the right window
• to have the app appear as in the existing screenshots, you can install/ run our app as a PWA: in Chrome there is an icon for this within the URL bar on the right ("install Octomind"/ launch from same place)
• for simple highlighting such as boxes and arrows, you can use MacOS Preview -> Markup tools
• to update the feature drops, take a look at the past releases

👩‍💻 Development

Enable corepack to let it manage pnpm and its version for you:

corepack enable

Run the following command at the root of your documentation (where mint.json is) to see a local preview.

pnpm dev

API docs

api docs is done based on a openapi.yaml definition. There is a few options on how to do this see api docs with mintlify.

In this repo we use the MDX way, that means we leverage the scraper tool. It is called like this

npx @mintlify/scraping@latest openapi-file ./api-ref/openapi.yaml -o api-ref

One can add additional information to the generated MDX documents if needed. Tags in the openapi.yaml definition will be converted to subdirectories in the api-ref directory to get a structure.

Linting

execute pnpm lint. Note for pull requests we require that all linting errors have been resolved

😎 Publishing Changes

Changes will be deployed to production automatically after pushing to the default branch.

You can also preview changes using PRs, which generates a preview link of the docs.

Troubleshooting

• Mintlify dev isn't running - Run mintlify install it'll re-install dependencies.
• Page loads as a 404 - Make sure you are running in a folder with mint.json