mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
205c4bc3a4
- Updated text.mdx - Updated image-embeds.mdx - Updated components/files.mdx - Updated list-table.mdx - Updated pages.mdx - Updated editor/branches.mdx - Updated navigation.mdx - Updated installation.mdx - Updated quickstart.mdx - Updated editor/getting-started.mdx - Updated editor/git-concepts.mdx Mintlify-Source: dashboard-editor
51 lines
1.7 KiB
Plaintext
51 lines
1.7 KiB
Plaintext
---
|
|
title: "Quickstart"
|
|
description: "Deploy your documentation in minutes "
|
|
icon: "rocket"
|
|
---
|
|
|
|
<Info>
|
|
**Prerequisites**: [Create an account](https://mintlify.com/start) and complete onboarding.
|
|
</Info>
|
|
|
|
## Getting started
|
|
|
|
Your site deploys to `https://<your-project-name>.mintlify.app`. Find the URL in your [dashboard](https://dashboard.mintlify.com/).
|
|
|
|
Install the GitHub App from **Settings** → **GitHub App**, then authorize your account under **Settings** → **My Profile** to enable auto-deploy on push.
|
|
|
|
# header
|
|
|
|
body text
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
## Editing workflows
|
|
|
|
**Code-based:** Install [mint](https://www.npmjs.com/package/mint) with `npm i -g mint`, run `mint dev` to preview at `localhost:3000`, then push to deploy.
|
|
|
|
**Web editor:** In your [dashboard](https://dashboard.mintlify.com), open **Editor**, edit, then **Publish**. Type <kbd>/</kbd> for the command menu. See the [web editor docs](/editor/getting-started).
|
|
|
|
## Custom domain
|
|
|
|
In [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain), add your domain and a CNAME record pointing to `cname.mintlify.app`. Propagation can take up to 48 hours.
|
|
|
|
## Next steps
|
|
|
|
<Card title="Configure global settings" icon="settings" horizontal href="settings">
|
|
Customize site-wide settings via `docs.json`.
|
|
</Card>
|
|
|
|
<Card title="Customize your theme" icon="paintbrush" horizontal href="themes">
|
|
Colors, fonts, and appearance.
|
|
</Card>
|
|
|
|
<Card title="Add components" icon="puzzle" horizontal href="/components/accordions">
|
|
Accordions, tabs, code samples, and more.
|
|
</Card>
|
|
|
|
<Card title="Set up API references" icon="code" horizontal href="/api-playground/overview">
|
|
OpenAPI and AsyncAPI specs.
|
|
</Card> |