mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Mintlify Agent
34 lines
1.2 KiB
Plaintext
34 lines
1.2 KiB
Plaintext
---
|
|
title: "Quickstart"
|
|
description: "Deploy your documentation site and make your first change."
|
|
keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "setup", "onboarding"]
|
|
---
|
|
|
|
## Deploy your site
|
|
|
|
Go to [mintlify.com/start](https://mintlify.com/start) to deploy your documentation. Connect your GitHub account and select a repository.
|
|
|
|
Your site is deployed at `https://<your-project-name>.mintlify.app`. Find your URL on the [dashboard](https://dashboard.mintlify.com/).
|
|
|
|
## Make your first change
|
|
|
|
Edit `index.mdx` in the [web editor](https://dashboard.mintlify.com/editor) or locally with the CLI:
|
|
|
|
```bash
|
|
npm i -g mint
|
|
mint dev
|
|
```
|
|
|
|
Publish from the web editor or push your changes to deploy automatically.
|
|
|
|
## 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> |