derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
82 lines
2.9 KiB
Plaintext
82 lines
2.9 KiB
Plaintext
---
|
|
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>
|