> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aihubmix.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Start building modern documentation in under five minutes

<Frame>
  <img className="block dark:hidden" src="https://mintlify-assets.b-cdn.net/hero-light.png" />

  <img className="hidden dark:block" src="https://mintlify-assets.b-cdn.net/hero-dark.png" />
</Frame>

## 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
    `docs.json` in the
    [dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings)

    <Frame>
      <img alt="Monorepo setup" className="block dark:hidden" src="https://mintcdn.com/aihubmix/UgvkHPDoK6o04763/images/monorepo-light.png?fit=max&auto=format&n=UgvkHPDoK6o04763&q=85&s=2e31a83e3e8d4ff9f5dd4fef9f235d84" width="1350" height="900" data-path="images/monorepo-light.png" />

      <img alt="Monorepo setup" className="hidden dark:block" src="https://mintcdn.com/aihubmix/5MPjueL0pHVMS1sd/images/monorepo-dark.png?fit=max&auto=format&n=5MPjueL0pHVMS1sd&q=85&s=1957ee2a4f29438f5e24e4a2305732d7" width="1350" height="900" data-path="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 `docs.json` file. Start with these basic configurations:

    ```json theme={null}
    "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 theme={null}
    ---
    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 `docs.json` with a URL.

    ```json theme={null}
    "openapi": "link-to-your-openapi-file"
    ```

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

    ```bash theme={null}
    npx @mintlify/scraping@latest openapi-file <path-or-url-to-openapi-file>
    ```

    3. Finally, include the generated endpoint MDX files to your `docs.json` under `navigation`.

    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).
  </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>
</AccordionGroup>

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

### 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://dashboard.mintlify.com/settings) to add a custom domain.

  <Frame>
    <img src="https://mintcdn.com/aihubmix/2nT-vfHReUtOnhMv/images/custom-domain.png?fit=max&auto=format&n=2nT-vfHReUtOnhMv&q=85&s=70e6f64021a23e0d6db9247f0b1df87f" alt="Custom Domain" width="1892" height="480" data-path="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
[support@mintlify.com](mailto:support@mintlify.com).