Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 38 additions & 1 deletion quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,19 @@
keywords: ["quickstart","deploy","get started","first steps"]
---

<Info>This guide takes approximately 5 minutes to complete.</Info>

After you complete this guide, you'll have a live documentation site ready to customize and update.

## Before you begin
## Prerequisites

Before starting, make sure you have:

- A [GitHub account](https://github.com/signup) (GitLab and Bitbucket are also supported)
- [Node.js](https://nodejs.org/en) v20.17.0 or higher (only required for CLI usage)
- A code editor like [VS Code](https://code.visualstudio.com/) (only required for local development)

## How Mintlify works

Mintlify uses a docs-as-code approach to manage your documentation. Every page on your site has a corresponding file stored in your documentation <Tooltip tip="Your documentation's source code where all files and their history are stored. The web editor connects to your documentation repository to access and modify content, or you can edit files locally in your preferred IDE.">repository</Tooltip>.

Expand All @@ -16,7 +26,7 @@

Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process. During onboarding, you'll connect your GitHub account, create or select a repository for your documentation, and install the GitHub App to enable automatic deployments.

After onboarding, your documentation site is deployed and accessible at your `.mintlify.app` URL.

Check warning on line 29 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L29

In general, use active voice instead of passive voice ('is deployed').

<AccordionGroup>
<Accordion title="Optional: Skip connecting GitHub during onboarding">
Expand Down Expand Up @@ -50,13 +60,17 @@
Your site is ready to view immediately. Use this URL for testing and sharing with your team. Before sharing with your users, you may want to add a [custom domain](/customize/custom-domain).
</Tip>

<Check>
**Success!** If you see your documentation site with the default Mintlify template, your deployment is working correctly. You're ready to make your first change.

Check warning on line 64 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L64

Don't use exclamation points in text.
</Check>

## Make your first change

<Tabs>
<Tab title="CLI">
<Steps>
<Step title="Install the CLI">
The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. Use an LTS version for stability.

Check warning on line 73 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L73

Spell out 'LTS', if it's unfamiliar to the audience.

<CodeGroup>

Expand Down Expand Up @@ -133,14 +147,37 @@
</Tab>
</Tabs>

## Troubleshooting

<AccordionGroup>
<Accordion title="GitHub App installation failed">
Make sure you have admin permissions on the repository you're trying to connect. If you're part of an organization, you may need an organization admin to approve the GitHub App installation.

Check warning on line 154 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L154

Use 'administrator' instead of 'admin'.

Check warning on line 154 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L154

Use 'administrator' instead of 'admin'.
</Accordion>
<Accordion title="Node.js version error when installing CLI">
Mintlify CLI requires Node.js v20.17.0 or higher. Check your version with `node --version` and update if needed. We recommend using [nvm](https://github.com/nvm-sh/nvm) to manage Node.js versions.
</Accordion>
<Accordion title="Deployment not updating after push">
Deployments typically complete within 1-2 minutes. Check the deployment status on your [dashboard](https://dashboard.mintlify.com/). If the deployment shows an error, review the build logs for details.
</Accordion>
<Accordion title="Local preview not loading">
Ensure you're running `mint dev` from the root of your documentation directory (where `docs.json` is located). If the port is in use, try `mint dev --port 3001`.

Check warning on line 163 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L163

In general, use active voice instead of passive voice ('is located').
</Accordion>
</AccordionGroup>

## Next steps

<Card title="Use the web editor" icon="mouse-pointer-2" horizontal href="/editor/index">
Edit documentation in your browser and preview how your pages will look when published.

Check warning on line 170 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L170

Avoid using 'will'.
</Card>
<Card title="Explore CLI commands" icon="terminal" horizontal href="/installation#additional-commands">
Find broken links, check accessibility, validate OpenAPI specs, and more.
</Card>
<Card title="Add a custom domain" icon="globe" horizontal href="/customize/custom-domain">
Use your own domain for your documentation site.
</Card>
<Card title="Customize your branding" icon="palette" horizontal href="/customize/styling/themes">
Update colors, fonts, and logos to match your brand.
</Card>
<Card title="Write your first page" icon="file-text" horizontal href="/essentials/markdown">
Learn MDX syntax and components to create rich documentation content.
</Card>
Loading