Setup your development
Learn how to update your docs locally and 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. 1. Install the Mintlify
CLI to preview the documentation changes locally with
this command:
npm i -g mintlify
2. Run the following command at the root of your
documentation (where mint.json
is): mintlify dev
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.