Skip to content

Simplify the quickstart page #454

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

Closed
wants to merge 1 commit into from
Closed

Simplify the quickstart page #454

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
234 changes: 78 additions & 156 deletions quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,170 +17,92 @@ icon: "rocket"

## Getting Started

Welcome! Follow the instructions below to learn how to deploy, update and
supercharge your documentation with Mintlify.

### Creating the Repository

Mintlify docs are rendered from MDX files and configurations defined in our
[starter kit](https://github.com/mintlify/starter). We use GitHub to integrate
your docs with your code, and make source control effortless. Onboard through the [dashboard](https://dashboard.mintlify.com) or clone our [starter kit](https://github.com/mintlify/starter) to get started.

<AccordionGroup>

<Accordion icon="message-bot" title="Install the GitHub app">

Install our GitHub app to ensure that your updates are automatically deployed when you push changes. You can find the installation link in the [dashboard](https://dashboard.mintlify.com/settings), on the Settings page. Upon successful installation, a check mark will appear next to the commit hash of the repository.

<Frame>
![GitHub Bot Verification](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png)
</Frame>

</Accordion>

<Accordion icon="code-branch" title="Monorepo Setup">
If you want your docs to live alongside your code as a monorepo setup, you
can: 1. Move your docs content to your monorepo. 2. Specify the path to your
`mint.json` in the
[dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings)
<Frame>
<img
alt="Monorepo setup"
className="block dark:hidden"
src="/images/monorepo-light.png"
/>
<img
alt="Monorepo setup"
className="hidden dark:block"
src="/images/monorepo-dark.png"
/>
</Frame>
</Accordion>

</AccordionGroup>

### Updating the Content

Mintlify enables you to easily customize the style, structure, and content of
your docs.

<AccordionGroup>
<Accordion icon="rectangle-terminal" title="Editing locally (recommended for developers)">

1. Install [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
2. Once git is installed, clone your docs repository using `git clone <your-repo>`. If you haven't set it up yet, now would be a good time to do so with these [SSH keys](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent).
3. Use your favorite IDE to open the repository.
4. Install our Mintlify CLI to preview changes with `npm i -g mintlify`.

Learn more about this in our [local development guide](/development).

</Accordion>

<Accordion icon="pen-to-square" title="Editing with the web editor">

Learn more about how to use the web editor on our [guide](/web-editor).

</Accordion>

<Accordion icon="palette" title="Customizing to your brand">

Easily customize colors, logos and buttons among other configurations in our `mint.json` file. Start with these basic configurations:

```json
"name": "Your Company"
"logo": {
"light": "/logo/light.svg",
"dark": "/logo/dark.svg",
"href": "https://yourcompany.com"
},
"favicon": "/favicon.svg",
"colors": {
"primary": "#2AB673",
"light": "#55D799",
"dark": "#117866",
},
```

A full list of supported configurations can be found at [global settings](/settings/global).

</Accordion>

<Accordion icon="pencil" title="Adding content">

Add content with simple MDX files. Initiate your pages with this template:

```md
---
title: "Page Title"
sidebarTitle: "Sidebar title (optional - if different from page title)"
description: "Subtitle (optional)"
---
```

Learn more about adding images, tables, lists, and more using the [MDX syntax](/text). We also offer a [wide array of components](/content/components).

</Accordion>

<Accordion icon="rocket" title="Pushing changes">

Once ready, commit and push your changes to update your docs site. Here is a [guide](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push) on how to do that. If the GitHub app is unable to successfully deploy your changes, you can manually update your docs through our [dashboard](https://dashboard.mintlify.com).

<Frame>
![Manual
Update](https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png)
</Frame>

</Accordion>

<Accordion icon="code-branch" title="Generating API references">

You can easily set up your API references using an OpenAPI document.

1. Add your `openapi.yaml` or `openapi.json` file into your docs repository or define the `openapi` field in `mint.json` with a URL.

```json
"openapi": "link-to-your-openapi-file"
```

2. Use our [scraper](/api-playground/openapi/setup#autogenerate-files-recommended) to autogenerate your OpenAPI endpoints files as:

Mintlify makes it easy to create beautiful documentation that your users will love. Follow these simple steps to get your documentation site up and running.

### Setting Up Your Repository

<Steps>
<Step title="Get the starter template">
Create a new repository using our [starter template](https://github.com/mintlify/starter) or onboard through the [dashboard](https://dashboard.mintlify.com).
</Step>
<Step title="Install GitHub app">
Install our GitHub app from your [dashboard settings](https://dashboard.mintlify.com/settings) to enable automatic deployments.
</Step>
<Step title="Preview changes locally">
```bash
npx @mintlify/scraping@latest openapi-file <path-or-url-to-openapi-file>
# Install the Mintlify CLI
npm i -g mintlify

# Start local development
mintlify dev
```
</Step>
</Steps>

3. Finally, include the generated endpoint MDX files to your `mint.json` under `navigation`.
### Making Updates

For a complete guide on using Mintlify with OpenAPI, check out [this guide](/api-playground/openapi/setup). [This guide](/api-playground/openapi/writing-openapi) explains how to configure your API authentication methods. For manual API references definition, explore [our syntax](/api-playground/overview).
There are two ways to update your documentation:

<AccordionGroup>
<Accordion icon="pen-to-square" title="Using the web editor">
The fastest way to update your docs is through our [web editor](/web-editor). It provides:
* Live preview of your changes
* Visual editing of content
* Direct publishing to your docs site
</Accordion>

<Accordion icon="chart-simple" title="Adding analytics">

Our in-house analytics give you insights into page views, search analytics, session recordings and more. Access these on your [dashboard](https://dashboard.mintlify.com/analytics).

We also support integrations with a range of analytics providers. You can find the list of providers [here](/integrations/analytics/overview).

<Accordion icon="rectangle-terminal" title="Using your IDE">
For developers, you can clone your repository and make changes locally:
1. Clone your docs repository
2. Make changes using your preferred editor
3. Preview with `mintlify dev`
4. Push changes to deploy

Learn more in our [local development guide](/development).
</Accordion>
</AccordionGroup>

<Note>
We provide a white-glove migration service as part of our Enterprise plan.
Interested? You can request it by [contacting us](mailto:[email protected]).
</Note>
### Customization

The `mint.json` file controls your documentation configuration. Here are the essential settings to get started:

```json
{
"name": "Your Company",
"logo": {
"light": "/logo/light.svg",
"dark": "/logo/dark.svg"
},
"favicon": "/favicon.svg",
"colors": {
"primary": "#2AB673",
"light": "#55D799",
"dark": "#117866"
}
}
```

Visit [global settings](/settings/global) to see all configuration options.

### Next Steps

Here are some helpful resources to get the most out of your documentation:

<CardGroup cols={2}>
<Card title="Add Content" icon="pencil" href="/text">
Learn how to add and format content with MDX
</Card>
<Card title="Set Up API" icon="code" href="/api-playground/overview">
Create interactive API documentation
</Card>
<Card title="Configure Design" icon="palette" href="/settings/global">
Customize your docs to match your brand
</Card>
<Card title="Get Support" icon="life-ring" href="mailto:[email protected]">
Reach out to us for help and feedback
</Card>
</CardGroup>

### Publishing

<Accordion icon="star" title="Adding a custom domain">

Integrate your docs into your website by hosting them on a custom domain. This is included in the free plan.

Navigate to your [dashboard settings](https://www.dashboard.mintlify.com/settings) to add a custom domain.

<Frame>![Custom Domain](/images/custom-domain.png)</Frame>

</Accordion>

Congrats! You've set up your Mintlify Docs and it's looking amazing! Need
support or want to give some feedback? You can join our
[community](https://mintlify.com/community) or drop us an email at
[[email protected]](mailto:[email protected]).
<Note>
Need help migrating existing documentation? We offer white-glove migration services with our Enterprise plan. [Contact us](mailto:[email protected]) to learn more.
</Note>
Loading