Quickstart
Start building awesome documentation in under 5 minutes
Setup your development
Learn how to update your docs locally and deploy them to the public.
Edit and preview
Clone your docs locally
Clone your docs locally
During the onboarding process, we created a repository on your Github with your docs content. You can find this repository on our dashboard. To clone the repository locally, follow these instructions in your terminal.
Preview changes
Preview changes
Previewing helps you make sure your changes look as intended. We built a command line interface to render these changes locally.
- Install the
Mintlify CLI to preview the
documentation changes locally with this command:
npm i -g mintlify - Run the following command at the root of your documentation (where
docs.jsonis):mintlify dev
If you’re currently using the legacy mint.json configuration file, please update the Mintlify CLI:
npm i -g mintlify@latest
And run the new upgrade command in your docs repository:
mintlify upgrade
You should now be using the new docs.json configuration file. Feel free to delete the mint.json file from your repository.
Deploy your changes
Install our Github app
Install our Github app
Our Github app automatically deploys your changes to your docs site, so you don’t need to manage deployments yourself. You can find the link to install on your dashboard. Once the bot has been successfully installed, there should be a check mark next to the commit hash of the repo.
Push your changes
Push your changes
Commit and push your changes to Git for your changes to update in your docs site. If you push and don’t see that the Github app successfully deployed your changes, you can also manually update your docs through our dashboard.
Update your docs
Add content directly in your files with MDX syntax and React components. You can use any of our components, or even build your own.
Add Content With MDX
Add content to your docs with MDX syntax.
Add Code Blocks
Add code directly to your docs with syntax highlighting.
Add Images
Add images to your docs to make them more engaging.
Add Custom Components
Add templates to your docs to make them more reusable.
Quickstart
Start building awesome documentation in under 5 minutes
Setup your development
Learn how to update your docs locally and deploy them to the public.
Edit and preview
Clone your docs locally
Clone your docs locally
During the onboarding process, we created a repository on your Github with your docs content. You can find this repository on our dashboard. To clone the repository locally, follow these instructions in your terminal.
Preview changes
Preview changes
Previewing helps you make sure your changes look as intended. We built a command line interface to render these changes locally.
- Install the
Mintlify CLI to preview the
documentation changes locally with this command:
npm i -g mintlify - Run the following command at the root of your documentation (where
docs.jsonis):mintlify dev
If you’re currently using the legacy mint.json configuration file, please update the Mintlify CLI:
npm i -g mintlify@latest
And run the new upgrade command in your docs repository:
mintlify upgrade
You should now be using the new docs.json configuration file. Feel free to delete the mint.json file from your repository.
Deploy your changes
Install our Github app
Install our Github app
Our Github app automatically deploys your changes to your docs site, so you don’t need to manage deployments yourself. You can find the link to install on your dashboard. Once the bot has been successfully installed, there should be a check mark next to the commit hash of the repo.
Push your changes
Push your changes
Commit and push your changes to Git for your changes to update in your docs site. If you push and don’t see that the Github app successfully deployed your changes, you can also manually update your docs through our dashboard.
Update your docs
Add content directly in your files with MDX syntax and React components. You can use any of our components, or even build your own.
Add Content With MDX
Add content to your docs with MDX syntax.
Add Code Blocks
Add code directly to your docs with syntax highlighting.
Add Images
Add images to your docs to make them more engaging.
Add Custom Components
Add templates to your docs to make them more reusable.