diff options
Diffstat (limited to 'packages/docs/quickstart.mdx')
| -rw-r--r-- | packages/docs/quickstart.mdx | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/packages/docs/quickstart.mdx b/packages/docs/quickstart.mdx index c711458ba..52243fba6 100644 --- a/packages/docs/quickstart.mdx +++ b/packages/docs/quickstart.mdx @@ -11,15 +11,15 @@ Get your documentation site running locally and make your first customization. <AccordionGroup> <Accordion icon="copy" title="Clone your docs locally"> - During the onboarding process, you created a GitHub repository with your docs content if you didn't already have one. You can find a link to this repository in your [dashboard](https://dashboard.mintlify.com). - - To clone the repository locally so that you can make and preview changes to your docs, follow the [Cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) guide in the GitHub docs. + During the onboarding process, you created a GitHub repository with your docs content if you didn't already have + one. You can find a link to this repository in your [dashboard](https://dashboard.mintlify.com). To clone the + repository locally so that you can make and preview changes to your docs, follow the [Cloning a + repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) guide + in the GitHub docs. </Accordion> <Accordion icon="rectangle-terminal" title="Start the preview server"> - 1. Install the Mintlify CLI: `npm i -g mint` - 2. Navigate to your docs directory and run: `mint dev` - 3. Open `http://localhost:3000` to see your docs live! - + 1. Install the Mintlify CLI: `npm i -g mint` 2. Navigate to your docs directory and run: `mint dev` 3. Open + `http://localhost:3000` to see your docs live! <Tip>Your preview updates automatically as you edit files.</Tip> </Accordion> </AccordionGroup> @@ -41,14 +41,14 @@ Get your documentation site running locally and make your first customization. 4. Save and see your changes instantly at `http://localhost:3000`. <Tip>Try changing the primary color to see an immediate difference!</Tip> + </Accordion> </AccordionGroup> ### Step 3: Go live <Accordion icon="rocket" title="Publish your docs"> - 1. Commit and push your changes. - 2. Your docs will update and be live in moments! + 1. Commit and push your changes. 2. Your docs will update and be live in moments! </Accordion> ## Next steps @@ -76,5 +76,6 @@ Now that you have your docs running, explore these key features: </CardGroup> <Note> - **Need help?** See our [full documentation](https://mintlify.com/docs) or join our [community](https://mintlify.com/community). + **Need help?** See our [full documentation](https://mintlify.com/docs) or join our + [community](https://mintlify.com/community). </Note> |