Skip to content

Condense quickstart page #3026

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mintlify-development wants to merge 1 commit into from
Closed

Condense quickstart page #3026

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
142 changes: 20 additions & 122 deletions quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,145 +4,43 @@ description: "Deploy your documentation site and make your first change."
keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "setup", "onboarding"]
---

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

## Before you begin

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>.

When you connect your documentation repository to your Mintlify deployment, you can work on your documentation locally or in the web editor and sync any changes to your remote repository.
Deploy a live documentation site in minutes and make your first edit.

## Deploy your documentation site

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.
Go to [mintlify.com/start](https://mintlify.com/start) and complete onboarding:
1. Connect your GitHub account
2. Create or select a documentation repository
3. Install the GitHub App for automatic deployments

After onboarding, your documentation site is deployed and accessible at your `.mintlify.app` URL.
Your site deploys to `https://<your-project-name>.mintlify.app`. Find your URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/).

<AccordionGroup>
<Accordion title="Optional: Skip connecting GitHub during onboarding">
If you want to get started quickly without connecting your own repository, you can skip the GitHub connection during onboarding. Mintlify creates a private repository in a private organization and automatically configures the GitHub App for you.

This lets you use the web editor immediately and migrate to your own repository later.
<Accordion title="Optional: Skip GitHub connection">
Skip GitHub connection during onboarding for immediate access. Mintlify creates a private repository and configures the GitHub App automatically. Migrate to your own repository later.
</Accordion>
</AccordionGroup>

## View your deployed site

Your documentation site is now deployed at `https://<your-project-name>.mintlify.app`.

Find your exact URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/).

<Frame>
<img
src="/images/quickstart/mintlify-domain-light.png"
alt="Overview page of the Mintlify dashboard."
className="block dark:hidden"
/>

<img
src="/images/quickstart/mintlify-domain-dark.png"
alt="Overview page of the Mintlify dashboard."
className="hidden dark:block"
/>
</Frame>

<Tip>
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>

## 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.

<CodeGroup>

```bash npm
npm i -g mint
```


```bash pnpm
pnpm add -g mint
```

</CodeGroup>

See [Install the CLI](/installation) for full details and troubleshooting.
</Step>
<Step title="Clone your repository">
If you haven't already cloned your repository locally, follow the instructions in [Clone your repository](/installation#clone-your-repository).
</Step>
<Step title="Edit a page">
Open `index.mdx` in your preferred editor and update the description in the frontmatter:

```mdx
---
title: "Introduction"
description: "Your custom description here"
---
```
</Step>
<Step title="Preview locally">
Run the following command from your documentation directory:

```bash
mint dev
```

View your preview at `http://localhost:3000`.
</Step>
<Step title="Push your changes">
Commit and push your changes to trigger a deployment:

```bash
git add .
git commit -m "Update description"
git push
```

Mintlify automatically deploys your changes. View your deployment status on the [Overview](https://dashboard.mintlify.com/) page of your dashboard.
</Step>
</Steps>
1. **Install CLI**: `npm i -g mint` (requires Node.js v20.17.0+)
2. **Clone repository**: Follow [installation guide](/installation#clone-your-repository)
3. **Edit page**: Update `index.mdx` description in frontmatter
4. **Preview**: Run `mint dev` and view at `localhost:3000`
5. **Deploy**: `git add . && git commit -m "Update description" && git push`
</Tab>
<Tab title="Web editor">
<Steps>
<Step title="Open the web editor">
Navigate to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard.
</Step>
<Step title="Edit a page">
Open the **Introduction** page and update the description.

<Frame>
<img src="/images/quickstart/hello-world-light.png" alt="Introduction page open in the web editor with the description edited to say Hello world!."
className="block dark:hidden"
/>
<img src="/images/quickstart/hello-world-dark.png" alt="Introduction page open in the web editor with the description edited to say Hello world!."
className="hidden dark:block"
/>
</Frame>
</Step>
<Step title="Publish">
Click the **Publish** button in the top-right of the web editor toolbar.
</Step>
<Step title="View live">
On the [Overview](https://dashboard.mintlify.com/) page of your dashboard, you can see your site's deployment status. When it finishes deploying, refresh your documentation site to see your changes live.
</Step>
</Steps>
1. Open the [web editor](https://dashboard.mintlify.com/editor)
2. Edit the **Introduction** page description
3. Click **Publish**
4. Check deployment status on [Overview](https://dashboard.mintlify.com/)
</Tab>
</Tabs>

## 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.
</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>
- [Use the web editor](/editor/index) - Edit in browser with live preview
- [Explore CLI commands](/installation#additional-commands) - Validate links, accessibility, OpenAPI specs
- [Add custom domain](/customize/custom-domain) - Use your own domain
Loading