diff options
| author | Dax Raad <[email protected]> | 2025-12-05 16:41:35 -0500 |
|---|---|---|
| committer | Dax Raad <[email protected]> | 2025-12-05 16:41:35 -0500 |
| commit | 328188816008fde10165597f432dac4c5d1016cd (patch) | |
| tree | e3230708f379c7e3451efc46e5d1c1ab66a26e20 /packages/docs/quickstart.mdx | |
| parent | c6d0ae892efcbd18652ff413ec3378099d31bc91 (diff) | |
| download | opencode-328188816008fde10165597f432dac4c5d1016cd.tar.gz opencode-328188816008fde10165597f432dac4c5d1016cd.zip | |
ignore: docs test
Diffstat (limited to 'packages/docs/quickstart.mdx')
| -rw-r--r-- | packages/docs/quickstart.mdx | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/packages/docs/quickstart.mdx b/packages/docs/quickstart.mdx new file mode 100644 index 000000000..c711458ba --- /dev/null +++ b/packages/docs/quickstart.mdx @@ -0,0 +1,80 @@ +--- +title: "Quickstart" +description: "Start building awesome documentation in minutes" +--- + +## Get started in three steps + +Get your documentation site running locally and make your first customization. + +### Step 1: Set up your local environment + +<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. + </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! + + <Tip>Your preview updates automatically as you edit files.</Tip> + </Accordion> +</AccordionGroup> + +### Step 2: Deploy your changes + +<AccordionGroup> + <Accordion icon="github" title="Install our GitHub app"> + Install the Mintlify GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app). + + Our GitHub app automatically deploys your changes to your docs site, so you don't need to manage deployments yourself. +</Accordion> +<Accordion icon="palette" title="Update your site name and colors"> + For a first change, let's update the name and colors of your docs site. + + 1. Open `docs.json` in your editor. + 2. Change the `"name"` field to your project name. + 3. Update the `"colors"` to match your brand. + 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! +</Accordion> + +## Next steps + +Now that you have your docs running, explore these key features: + +<CardGroup cols={2}> + +<Card title="Write Content" icon="pen-to-square" href="/essentials/markdown"> + Learn MDX syntax and start writing your documentation. +</Card> + +<Card title="Customize style" icon="palette" href="/essentials/settings"> + Make your docs match your brand perfectly. +</Card> + +<Card title="Add code examples" icon="square-code" href="/essentials/code"> + Include syntax-highlighted code blocks. +</Card> + +<Card title="API documentation" icon="code" href="/api-reference/introduction"> + Auto-generate API docs from OpenAPI specs. +</Card> + +</CardGroup> + +<Note> + **Need help?** See our [full documentation](https://mintlify.com/docs) or join our [community](https://mintlify.com/community). +</Note> |
