Skip to content

Latest commit

 

History

History
84 lines (63 loc) · 2.56 KB

quickstart.mdx

File metadata and controls

84 lines (63 loc) · 2.56 KB
title description
Quickstart
Start building awesome documentation in under 5 minutes

Create your docs repo

Learn how to set up your documentation repository.

1. Navigate to our [Starter Kit](https://github.com/mintlify/starter). 2. Click on `Use this Template` to copy the Mintlify starter kit. ![](/images/use-this-template.png) 3. Create a new repository with the appropriate name and sharing preferances. ![](/images/new-repository.png) 4. Fill out our [Onboarding Form](https://mintlify.typeform.com/start) with your repo details to deploy your docs 5. You’re all set! Now it’s time to update, style, and personalize your docs

Setup your development

Learn how to update your docs locally and and deploy them to the public.

1. Clone the repository you just made. 2. Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally with this command: ``` npm i -g mintlify ``` 4. Run the following command at the root of your documentation (where `mint.json` is): ``` mintlify dev ``` Mintlify automatically deploys your docs when your push to Git through our Mintlify Github App. The link to install should have been sent to you after you deployed your docs. [Let us know](mailto:kate@mintlify.com) if you need a new link.

Once the bot has been successfully installed, there should be a check mark next to the commit hash of the repo.

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 flair to your docs with personalized branding.

<Card title="Add API Endpoints" icon="square-code" href="/api-playground/configuration"

Implement your OpenAPI spec and enable API user interaction.

<Card title="Integrate Analytics" icon="chart-mixed" href="/analytics/supported-integrations"

Draw insights from user interactions with your documentation.

<Card title="Host on a Custom Domain" icon="browser" href="/settings/custom-domain/subdomain"

Keep your docs on your own website’s subdomain.