Skip to content

Mintlify Docs Edits #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rtbarnes wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Mintlify Docs Edits #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions docs/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@ es_link: "https://developers.example.es/docs/quickstart"

## Get started in three steps

Get your documentation site running locally to make your changes. The best way to do this is following each step in order; laying a good foundation here will pay dividends. Make sure you have a good understanding of the steps before you move on to the next one.
Get your documentation site running locally to make your changes. The best way to do this is following each step in order; laying a really good foundation here will pay dividends. Make sure you have a good understanding of the steps before you move on to the next one.

### Step 1: Set up your local environment

<AccordionGroup>
<Accordion title="Clone your docs locally" icon="copy">
<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 title="Start the preview server" icon="rectangle-terminal">
<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!
Expand All @@ -34,12 +34,12 @@ Get your documentation site running locally to make your changes. The best way t
### Step 2: Deploy your changes

<AccordionGroup>
<Accordion title="Install our GitHub app" icon="github">
<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 title="Update your site name and colors" icon="palette">
<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.
Expand All @@ -55,7 +55,7 @@ Get your documentation site running locally to make your changes. The best way t

### Step 3: Go live

<Accordion title="Publish your docs" icon="rocket">
<Accordion icon="rocket" title="Publish your docs">
1. Commit and push your changes.
2. Your docs will update and be live in moments!
</Accordion>
Expand All @@ -75,54 +75,54 @@ Now that you have your docs running, explore these key features:

<Note>
**Example XML feed**: <a href="/feed.xml" download>
Download feed.xml</a>
Download feed.xml</a>

to see how static XML files are served.
</Note>

<CardGroup cols={2}>
<Card title="Write Content" icon="pen-to-square" href="/essentials/markdown">
<Card icon="pen-to-square" href="/essentials/markdown" title="Write Content">
Learn MDX syntax and start writing your documentation.
</Card>
<Card title="Customize style" icon="palette" href="/essentials/settings">
<Card icon="palette" href="/essentials/settings" title="Customize style">
Make your docs match your brand perfectly.
</Card>
<Card title="Add code examples" icon="square-code" href="/essentials/code">
<Card icon="square-code" href="/essentials/code" title="Add code examples">
Include syntax-highlighted code blocks.
</Card>
<Card title="API documentation" icon="code" href="/api-reference/introduction">
<Card icon="code" href="/api-reference/introduction" title="API documentation">
Auto-generate API docs from OpenAPI specs.
</Card>
<Card title="Get Plants API" icon="code" href="/api-reference/endpoint/get">
<Card icon="code" href="/api-reference/endpoint/get" title="Get Plants API">
View the Get Plants endpoint documentation.
</Card>
<Card title="User API documentation" icon="code" href="api-reference/list-all-users">
<Card icon="code" href="api-reference/list-all-users" title="User API documentation">
View the User API documentation.
</Card>
</CardGroup>

## Essential features

<CardGroup cols={2}>
<Card title="Content management" icon="file-lines">
<Card icon="file-lines" title="Content management">
- Create and organize MDX files
- Use frontmatter for metadata
- Add images and assets
- Structure with headings and sections
</Card>
<Card title="Customization options" icon="sliders">
<Card icon="sliders" title="Customization options">
- Configure site colors and branding
- Customize navigation structure
- Add custom CSS and components
- Set up search functionality
</Card>
<Card title="Developer tools" icon="wrench">
<Card icon="wrench" title="Developer tools">
- Hot reload preview server
- Automatic deployments via GitHub
- Version control integration
- CLI commands for common tasks
</Card>
<Card title="Documentation features" icon="book">
<Card icon="book" title="Documentation features">
- Syntax-highlighted code blocks
- Interactive API documentation
- Search and navigation
Expand All @@ -133,19 +133,19 @@ Now that you have your docs running, explore these key features:
## Quick tips

<CardGroup cols={3}>
<Card title="Getting started" icon="lightbulb">
<Card icon="lightbulb" title="Getting started">
- Install Mintlify CLI globally
- Clone your repository locally
- Run `mint dev` to preview
- Make changes and see updates instantly
</Card>
<Card title="Best practices" icon="star">
<Card icon="star" title="Best practices">
- Keep content organized in folders
- Use descriptive file names
- Write clear, concise documentation
- Test your changes locally first
</Card>
<Card title="Troubleshooting" icon="circle-question">
<Card icon="circle-question" title="Troubleshooting">
- Check your `docs.json` configuration
- Verify file paths and links
- Review console for errors
Expand Down