diff --git a/quickstart.mdx b/quickstart.mdx index bc56bad0b..96a55bcec 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -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 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 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://.mintlify.app`. Find your URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/). - - 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. + + 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. -## 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). - - ## Make your first change - - - 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: - - ```mdx - --- - title: "Introduction" - description: "Your custom description here" - --- - ``` - - - Run the following command from your documentation directory: - - ```bash - mint dev - ``` - - 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. - - + 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` - - - Navigate to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard. - - - Open the **Introduction** page and update the description. - - - Introduction page open in the web editor with the description edited to say Hello world!. - Introduction page open in the web editor with the description edited to say Hello world!. - - - - 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. - - + 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/) ## Next steps - - Edit documentation in your browser and preview how your pages will look when published. - - - Find broken links, check accessibility, validate OpenAPI specs, and more. - - - Use your own domain for your documentation site. - \ No newline at end of file +- [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 \ No newline at end of file