diff --git a/quickstart.mdx b/quickstart.mdx index 25d519d91..7225577d8 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -1,54 +1,13 @@ --- title: "Quickstart" description: "Deploy your documentation site and make your first change." -keywords: ["quickstart","deploy","get started","first steps"] --- -After you complete this guide, you'll have a live documentation site ready to customize and update. +## Deploy your site -## Before you begin +Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process. You'll connect your GitHub account and create a repository for your documentation. -Mintlify uses a docs-as-code approach to manage your documentation. Every page on your site has a corresponding file stored in your documentation repository. - -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 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. - -After onboarding, your documentation site is deployed and accessible at your `.mintlify.app` URL. - - - - 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. - - - -## View your deployed site - -Your documentation site is now deployed at `https://.mintlify.app`. - -Find your exact URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/). - - - Overview page of the Mintlify dashboard. - - Overview page of the Mintlify dashboard. - - - - 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). - +Your site deploys to `https://.mintlify.app`. Find your URL on the [dashboard](https://dashboard.mintlify.com/). ## Make your first change @@ -56,28 +15,20 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa - The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. Use an LTS version for stability. - ```bash npm npm i -g mint ``` - ```bash pnpm pnpm add -g mint ``` - - See [Install the CLI](/installation) for full details and troubleshooting. - - - If you haven't already cloned your repository locally, follow the instructions in [Clone your repository](/installation#clone-your-repository). - Open `index.mdx` in your preferred editor and update the description in the frontmatter: + Open `index.mdx` and update the description: ```mdx --- @@ -87,8 +38,6 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa ``` - Run the following command from your documentation directory: - ```bash mint dev ``` @@ -96,25 +45,21 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa View your preview at `http://localhost:3000`. - 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. - Navigate to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard. + Navigate to the [web editor](https://dashboard.mintlify.com/editor). - Open `index.mdx` and update the description in the frontmatter: + Open `index.mdx` and update the description: ```mdx --- @@ -124,10 +69,7 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa ``` - Click the **Publish** button in the top-right of the web editor toolbar. - - - 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. + Click **Publish** in the top-right of the toolbar. @@ -135,14 +77,14 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa ## Next steps - - - Edit documentation in your browser and preview how your pages will look when published. + + + Edit documentation in your browser. - - Find broken links, check accessibility, validate OpenAPI specs, and more. + + Preview locally and validate your docs. - - Use your own domain for your documentation site. + + Use your own domain. - \ No newline at end of file +