# Create Plant
Source: https://maple.mintlify.app/api-reference/endpoint/create

POST /plants
Creates a new plant in the store



# Delete Plant
Source: https://maple.mintlify.app/api-reference/endpoint/delete

DELETE /plants/{id}
Deletes a single plant based on the ID supplied



# Get Plants
Source: https://maple.mintlify.app/api-reference/endpoint/get

GET /plants
Returns all plants from the system that the user has access to



# Introduction
Source: https://maple.mintlify.app/api-reference/introduction

Example section for showcasing API endpoints

<Note>
  If you're not looking to build API reference documentation, you can delete
  this section by removing the api-reference folder.
</Note>

## Welcome

There are two ways to build API documentation: [OpenAPI](https://www.mintlify.com/docs/api-playground/openapi-setup) and [MDX components](https://www.mintlify.com/docs/api-playground/mdx-overview). For the starter kit, we are using the following OpenAPI specification.

<Card title="Plant Store Endpoints" icon="leaf" href="https://github.com/mintlify/starter/blob/main/api-reference/openapi.json">
  View the OpenAPI specification file
</Card>

## Authentication

All API endpoints are authenticated using Bearer tokens and picked up from the specification file.

```json theme={null}
"security": [
  {
    "bearerAuth": []
  }
]
```


# Development
Source: https://maple.mintlify.app/development

Learn how to preview changes locally

<Info>
  **Prerequisite** You should have installed Node.js (version 18.10.0 or
  higher).
</Info>

Step 1. Install Mintlify on your OS:

<CodeGroup>
  ```bash npm theme={null}
  npm i -g mintlify
  ```

  ```bash yarn theme={null}
  yarn global add mintlify
  ```
</CodeGroup>

Step 2. Go to the docs are located (where you can find `docs.json`) and run the following command:

```bash theme={null}
mintlify dev
```

The documentation website is now available at `http://localhost:3000`.

### Custom Ports

Mintlify uses port 3000 by default. You can use the `--port` flag to customize the port Mintlify runs on. For example, use this command to run in port 3333:

```bash theme={null}
mintlify dev --port 3333
```

You will see an error like this if you try to run Mintlify in a port that's already taken:

```md theme={null}
Error: listen EADDRINUSE: address already in use :::3000
```

## Mintlify Versions

Each CLI is linked to a specific version of Mintlify. Please update the CLI if your local website looks different than production.

<CodeGroup>
  ```bash npm theme={null}
  npm i -g mintlify@latest
  ```

  ```bash yarn theme={null}
  yarn global upgrade mintlify
  ```
</CodeGroup>

## Deployment

<Tip>
  Unlimited editors available under the [Startup
  Plan](https://mintlify.com/pricing)
</Tip>

You should see the following if the deploy successfully went through:

<Frame>
  <img />
</Frame>

## Troubleshooting

Here's how to solve some common problems when working with the CLI.

<AccordionGroup>
  <Accordion title="Mintlify is not loading">
    Update to Node v18. Run `mintlify install` and try again.
  </Accordion>

  <Accordion title="No such file or directory on Windows">
    Go to the `C:/Users/Username/.mintlify/` directory and remove the `mint`
    folder. Then Open the Git Bash in this location and run `git clone
        https://github.com/mintlify/mint.git`.

    Repeat step 3.
  </Accordion>

  <Accordion title="Getting an unknown error">
    Try navigating to the root of your device and delete the \~/.mintlify folder.
    Then run `mintlify dev` again.
  </Accordion>
</AccordionGroup>


# Code Blocks
Source: https://maple.mintlify.app/essentials/code

Display inline code and code blocks

## Basic

### Inline Code

To denote a `word` or `phrase` as code, enclose it in backticks (\`).

```
To denote a `word` or `phrase` as code, enclose it in backticks (`).
```

### Code Block

Use [fenced code blocks](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) by enclosing code in three backticks and follow the leading ticks with the programming language of your snippet to get syntax highlighting. Optionally, you can also write the name of your code after the programming language.

```java HelloWorld.java theme={null}
class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}
```

````md theme={null}
```java HelloWorld.java
class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}
```
````


# Images and Embeds
Source: https://maple.mintlify.app/essentials/images

Add image, video, and other HTML elements

<img />

## Image

### Using Markdown

The [markdown syntax](https://www.markdownguide.org/basic-syntax/#images) lets you add images using the following code

```md theme={null}
![title](/path/image.jpg)
```

Note that the image file size must be less than 5MB. Otherwise, we recommend hosting on a service like [Cloudinary](https://cloudinary.com/) or [S3](https://aws.amazon.com/s3/). You can then use that URL and embed.

### Using Embeds

To get more customizability with images, you can also use embeds to add images.

```html theme={null}
<img height="200" src="/path/image.jpg" />
```

## Embeds and HTML elements

<iframe title="YouTube video player" />

<br />

<Tip>
  Mintlify supports [HTML tags in Markdown](https://www.markdownguide.org/basic-syntax/#html). This is helpful if you prefer HTML tags to Markdown syntax, and lets you create documentation with infinite flexibility.
</Tip>

### iFrames

Loads another HTML page within the document. Most commonly used for embedding videos.

```html theme={null}
<iframe src="https://www.youtube.com/embed/4KzFe50RQkQ"> </iframe>
```


# Markdown Syntax
Source: https://maple.mintlify.app/essentials/markdown

Text, title, and styling in standard markdown

## Titles

Best used for section headers.

```md theme={null}
## Titles
```

### Subtitles

Best use to subsection headers.

```md theme={null}
### Subtitles
```

<Tip>
  Each **title** and **subtitle** creates an anchor and also shows up on the table of contents on the right.
</Tip>

## Text Formatting

We support most markdown formatting. Simply add `**`, `_`, or `~` around text to format it.

| Style         | How to write it   | Result            |
| ------------- | ----------------- | ----------------- |
| Bold          | `**bold**`        | **bold**          |
| Italic        | `_italic_`        | *italic*          |
| Strikethrough | `~strikethrough~` | ~~strikethrough~~ |

You can combine these. For example, write `**_bold and italic_**` to get ***bold and italic*** text.

You need to use HTML to write superscript and subscript text. That is, add `<sup>` or `<sub>` around your text.

| Text Size   | How to write it          | Result                 |
| ----------- | ------------------------ | ---------------------- |
| Superscript | `<sup>superscript</sup>` | <sup>superscript</sup> |
| Subscript   | `<sub>subscript</sub>`   | <sub>subscript</sub>   |

## Linking to Pages

You can add a link by wrapping text in `[]()`. You would write `[link to google](https://google.com)` to [link to google](https://google.com).

Links to pages in your docs need to be root-relative. Basically, you should include the entire folder path. For example, `[link to text](/writing-content/text)` links to the page "Text" in our components section.

Relative links like `[link to text](../text)` will open slower because we cannot optimize them as easily.

## Blockquotes

### Singleline

To create a blockquote, add a `>` in front of a paragraph.

> Dorothy followed her through many of the beautiful rooms in her castle.

```md theme={null}
> Dorothy followed her through many of the beautiful rooms in her castle.
```

### Multiline

> Dorothy followed her through many of the beautiful rooms in her castle.
>
> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

```md theme={null}
> Dorothy followed her through many of the beautiful rooms in her castle.
>
> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
```

### LaTeX

Mintlify supports [LaTeX](https://www.latex-project.org) through the Latex component.

<Latex>8 x (vk x H1 - H2) = (0,1)</Latex>

```md theme={null}
<Latex>8 x (vk x H1 - H2) = (0,1)</Latex>
```


# Navigation
Source: https://maple.mintlify.app/essentials/navigation

The navigation field in docs.json defines the pages that go in the navigation menu

The navigation menu is the list of links on every website.

You will likely update `docs.json` every time you add a new page. Pages do not show up automatically.

## Navigation syntax

Our navigation syntax is recursive which means you can make nested navigation groups. You don't need to include `.mdx` in page names.

<CodeGroup>
  ```json Regular Navigation theme={null}
  "navigation": [
      {
          "group": "Getting Started",
          "pages": ["quickstart"]
      }
  ]
  ```

  ```json Nested Navigation theme={null}
  "navigation": [
      {
          "group": "Getting Started",
          "pages": [
              "quickstart",
              {
                  "group": "Nested Reference Pages",
                  "pages": ["nested-reference-page"]
              }
          ]
      }
  ]
  ```
</CodeGroup>

## Folders

Simply put your MDX files in folders and update the paths in `docs.json`.

For example, to have a page at `https://yoursite.com/your-folder/your-page` you would make a folder called `your-folder` containing an MDX file called `your-page.mdx`.

<Warning>
  You cannot use `api` for the name of a folder unless you nest it inside another folder. Mintlify uses Next.js which reserves the top-level `api` folder for internal server calls. A folder name such as `api-reference` would be accepted.
</Warning>

```json Navigation With Folder theme={null}
"navigation": [
    {
        "group": "Group Name",
        "pages": ["your-folder/your-page"]
    }
]
```

## Hidden Pages

MDX files not included in `docs.json` will not show up in the sidebar but are accessible through the search bar and by linking directly to them.


# Reusable Snippets
Source: https://maple.mintlify.app/essentials/reusable-snippets

Reusable, custom snippets to keep content in sync

One of the core principles of software development is DRY (Don't Repeat
Yourself). This is a principle that apply to documentation as
well. If you find yourself repeating the same content in multiple places, you
should consider creating a custom snippet to keep your content in sync.

## Creating a custom snippet

**Pre-condition**: You must create your snippet file in the `snippets` directory.

<Note>
  Any page in the `snippets` directory will be treated as a snippet and will not
  be rendered into a standalone page. If you want to create a standalone page
  from the snippet, import the snippet into another file and call it as a
  component.
</Note>

### Default export

1. Add content to your snippet file that you want to re-use across multiple
   locations. Optionally, you can add variables that can be filled in via props
   when you import the snippet.

```mdx snippets/my-snippet.mdx theme={null}
Hello world! This is my content I want to reuse across pages. My keyword of the
day is {word}.
```

<Warning>
  The content that you want to reuse must be inside the `snippets` directory in
  order for the import to work.
</Warning>

2. Import the snippet into your destination file.

```mdx destination-file.mdx theme={null}
---
title: My title
description: My Description
---

import MySnippet from '/snippets/path/to/my-snippet.mdx';

## Header

Lorem impsum dolor sit amet.

<MySnippet word="bananas" />
```

### Reusable variables

1. Export a variable from your snippet file:

```mdx snippets/path/to/custom-variables.mdx theme={null}
export const myName = 'my name';

export const myObject = { fruit: 'strawberries' };
```

2. Import the snippet from your destination file and use the variable:

```mdx destination-file.mdx theme={null}
---
title: My title
description: My Description
---

import { myName, myObject } from '/snippets/path/to/custom-variables.mdx';

Hello, my name is {myName} and I like {myObject.fruit}.
```

### Reusable components

1. Inside your snippet file, create a component that takes in props by exporting
   your component in the form of an arrow function.

```mdx snippets/custom-component.mdx theme={null}
export const MyComponent = ({ title }) => (
  <div>
    <h1>{title}</h1>
    <p>... snippet content ...</p>
  </div>
);
```

<Warning>
  MDX does not compile inside the body of an arrow function. Stick to HTML
  syntax when you can or use a default export if you need to use MDX.
</Warning>

2. Import the snippet into your destination file and pass in the props

```mdx destination-file.mdx theme={null}
---
title: My title
description: My Description
---

import { MyComponent } from '/snippets/custom-component.mdx';

Lorem ipsum dolor sit amet.

<MyComponent title={'Custom title'} />
```


# Settings
Source: https://maple.mintlify.app/essentials/settings

Configure the global settings for your documentation

<Card title="The docs.json file" href="#reference" icon="file-code-2">
  Skip to the reference
</Card>

Every documentation site requires a **docs.json** file.

This file contains the global configuration settings and controls everything from styling and navigation to integrations.

## Reference

This section contains the full reference for the docs.json file.

### Customization

<ResponseField name="theme">
  One of the following: `mint`, `maple`, `palm`, `willow`, `linden`, `almond`.

  The layout theme of the project. Check out the [Themes](/core-concepts/themes) page for more information.
</ResponseField>

<ResponseField name="name" type="string">
  The name of the project, organization, or product
</ResponseField>

<ResponseField name="colors" type="object">
  The colors to use in your documentation. At the very least, you must define the primary color. For example:

  ```json theme={null}
  {
    "colors": {
      "primary": "#ff0000"
    }
  }
  ```

  <Expandable title="Colors">
    <ResponseField name="primary" type="string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$">
      The primary color of the theme

      Must be a hex code beginning with `#`
    </ResponseField>

    <ResponseField name="light" type="string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$">
      The light color of the theme. Used for dark mode

      Must be a hex code beginning with `#`
    </ResponseField>

    <ResponseField name="dark" type="string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$">
      The dark color of the theme. Used for light mode

      Must be a hex code beginning with `#`
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="description" type="string">
  Optional description used for SEO and LLM indexing
</ResponseField>

<ResponseField name="logo" type="string or object">
  The logo (for both light and dark mode)

  <Expandable title="Logo">
    <ResponseField name="light" type="string">
      Path pointing to the light logo file to use in dark mode, including the file extension. Example: `/logo.png`
    </ResponseField>

    <ResponseField name="dark" type="string">
      Path pointing to the dark logo file to use in light mode, including the file extension. Example: `/logo-dark.png`
    </ResponseField>

    <ResponseField name="href" type="string (uri)">
      The URL to redirect to when clicking the logo. If not provided, the logo will link to the homepage. Example: `https://example.com`
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="favicon" type="string or object">
  The path to your favicon file in the docs folder, including the file extension. The file will automatically be resized to appropriate favicon sizes.
  Can be a single file or a pair for light and dark mode. Example: `/favicon.png`

  <Expandable title="Favicon">
    <ResponseField name="light" type="string">
      Path pointing to the light favicon file to use in dark mode, including the file extension. Example: `/favicon.png`
    </ResponseField>

    <ResponseField name="dark" type="string">
      Path pointing to the dark favicon file to use in light mode, including the file extension. Example: `/favicon-dark.png`
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="styling" type="object">
  Styling configurations

  <Expandable title="Styling">
    <ResponseField name="eyebrows" type="&#x22;section&#x22; | &#x22;breadcrumbs&#x22;">
      The eyebrows style of the content. Defaults to `section`.
    </ResponseField>

    <ResponseField name="codeblocks" type="&#x22;system&#x22; | &#x22;dark&#x22;">
      The codeblock theme. Defaults to `system`.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="icons" type="object">
  Icon library settings

  <Expandable title="Icons">
    <ResponseField name="library" type="&#x22;fontawesome&#x22; | &#x22;lucide&#x22;">
      The icon library to be used. Defaults to `fontawesome`.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="fonts" type="object">
  <Expandable title="Fonts">
    <ResponseField name="family" type="string">
      The font family, such as "Open Sans", "Playfair Display"
    </ResponseField>

    <ResponseField name="weight" type="number">
      The font weight, such as 400, 700. Precise font weights such as 550 are supported for variable fonts.
    </ResponseField>

    <ResponseField name="source" type="string (uri)">
      The font source, such as [https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2](https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2)
    </ResponseField>

    <ResponseField name="format" type="&#x22;woff&#x22; | &#x22;woff2&#x22;">
      The font format, can be one of woff, woff2
    </ResponseField>

    <ResponseField name="heading" type="object">
      <Expandable title="Heading">
        <ResponseField name="family" type="string">
          The font family, such as "Open Sans", "Playfair Display"
        </ResponseField>

        <ResponseField name="weight" type="number">
          The font weight, such as 400, 700. Precise font weights such as 550 are supported for variable fonts.
        </ResponseField>

        <ResponseField name="source" type="string (uri)">
          The font source, such as [https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2](https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2)
        </ResponseField>

        <ResponseField name="format" type="&#x22;woff&#x22; | &#x22;woff2&#x22;">
          The font format, can be one of woff, woff2
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="body" type="object">
      <Expandable title="Body">
        <ResponseField name="family" type="string">
          The font family, such as "Open Sans", "Playfair Display"
        </ResponseField>

        <ResponseField name="weight" type="number">
          The font weight, such as 400, 700. Precise font weights such as 550 are supported for variable fonts.
        </ResponseField>

        <ResponseField name="source" type="string (uri)">
          The font source, such as [https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2](https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2)
        </ResponseField>

        <ResponseField name="format" type="&#x22;woff&#x22; | &#x22;woff2&#x22;">
          The font format, can be one of woff, woff2
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="appearance" type="object">
  Light / dark mode toggle settings

  <Expandable title="Appearance">
    <ResponseField name="default" type="&#x22;system&#x22; | &#x22;light&#x22; | &#x22;dark&#x22;">
      The default light/dark mode. Defaults to `system`
    </ResponseField>

    <ResponseField name="strict" type="boolean">
      Whether to hide the light / dark mode toggle. Defaults to `true`.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="background" type="object">
  Background color and decoration settings

  <Expandable title="Background">
    <ResponseField name="image" type="string or object">
      <Expandable title="Image">
        <ResponseField name="light" type="string" />

        <ResponseField name="dark" type="string" />
      </Expandable>
    </ResponseField>

    <ResponseField name="decoration" type="&#x22;gradient&#x22; | &#x22;grid&#x22; | &#x22;windows&#x22;">
      The background decoration of the theme
    </ResponseField>

    <ResponseField name="color" type="object">
      The colors of the background

      <Expandable title="Color">
        <ResponseField name="light" type="string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$">
          The color in hex format to use in light mode

          Must match pattern: ^#(\[a-fA-F0-9]|\[a-fA-F0-9])\$
        </ResponseField>

        <ResponseField name="dark" type="string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$">
          The color in hex format to use in dark mode

          Must match pattern: ^#(\[a-fA-F0-9]|\[a-fA-F0-9])\$
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

### Structure

<ResponseField name="navbar" type="object">
  Navbar content and settings

  <Expandable title="Navbar">
    <ResponseField name="links" type="array of object">
      The links in the navbar

      <Expandable title="Links">
        <ResponseField name="label" type="string" />

        <ResponseField name="href" type="string (uri)">
          A valid path or external link
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="primary" type="object">
      <Expandable title="Primary">
        <ResponseField name="type" type="&#x22;button&#x22; | &#x22;github&#x22;" />

        <ResponseField name="label" type="string">
          The label for the primary button. This only applies when `type` is set to `button`.
        </ResponseField>

        <ResponseField name="href" type="string (uri)">
          A valid path or external link. If `type` is set to `github`, this will be the URL to the repository.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="navigation" type="object">
  The navigation structure of the content

  <Expandable title="Navigation">
    <ResponseField name="global" type="object">
      Add external links that will appear on all sections and pages irregardless of navigation nesting

      <Expandable title="Global">
        <ResponseField name="languages" type="array of object">
          <Expandable title="Languages">
            <ResponseField name="language" type="&#x22;en&#x22; | &#x22;cn&#x22; | &#x22;zh&#x22; | &#x22;zh-Hans&#x22; | &#x22;zh-Hant&#x22; | &#x22;es&#x22; | &#x22;fr&#x22; | &#x22;ja&#x22; | &#x22;jp&#x22; | &#x22;pt&#x22; | &#x22;pt-BR&#x22; | &#x22;de&#x22; | &#x22;ko&#x22; | &#x22;it&#x22; | &#x22;ru&#x22; | &#x22;id&#x22; | &#x22;ar&#x22; | &#x22;tr&#x22;">
              The name of the language in the ISO 639-1 format
            </ResponseField>

            <ResponseField name="default" type="boolean">
              Whether this language is the default language
            </ResponseField>

            <ResponseField name="hidden" type="boolean">
              Whether the current option is default hidden
            </ResponseField>

            <ResponseField name="href" type="string (uri)">
              A valid path or external link
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="versions" type="array of object">
          <Expandable title="Versions">
            <ResponseField name="version" type="string">
              The name of the version

              Minimum length: 1
            </ResponseField>

            <ResponseField name="default" type="boolean">
              Whether this version is the default version
            </ResponseField>

            <ResponseField name="hidden" type="boolean">
              Whether the current option is default hidden
            </ResponseField>

            <ResponseField name="href" type="string (uri)">
              An external link
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="tabs" type="array of object">
          <Expandable title="Tabs">
            <ResponseField name="tab" type="string">
              The name of the tab

              Minimum length: 1
            </ResponseField>

            <ResponseField name="icon" type="string or object">
              The icon to be displayed in the section
            </ResponseField>

            <ResponseField name="hidden" type="boolean">
              Whether the current option is default hidden
            </ResponseField>

            <ResponseField name="href" type="string (uri)">
              An external link
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="anchors" type="array of object">
          <Expandable title="Anchors">
            <ResponseField name="anchor" type="string">
              The name of the anchor

              Minimum length: 1
            </ResponseField>

            <ResponseField name="icon" type="string or object">
              The icon to be displayed in the section
            </ResponseField>

            <ResponseField name="color" type="object">
              <Expandable title="Color">
                <ResponseField name="light" type="string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$">
                  The color in hex format to use in light mode

                  Must match pattern: ^#(\[a-fA-F0-9]|\[a-fA-F0-9])\$
                </ResponseField>

                <ResponseField name="dark" type="string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$">
                  The color in hex format to use in dark mode

                  Must match pattern: ^#(\[a-fA-F0-9]|\[a-fA-F0-9])\$
                </ResponseField>
              </Expandable>
            </ResponseField>

            <ResponseField name="hidden" type="boolean">
              Whether the current option is default hidden
            </ResponseField>

            <ResponseField name="href" type="string (uri)">
              A valid path or external link
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="dropdowns" type="array of object">
          <Expandable title="Dropdowns">
            <ResponseField name="dropdown" type="string">
              The name of the dropdown

              Minimum length: 1
            </ResponseField>

            <ResponseField name="icon" type="string or object">
              The icon to be displayed in the section
            </ResponseField>

            <ResponseField name="hidden" type="boolean">
              Whether the current option is default hidden
            </ResponseField>

            <ResponseField name="href" type="string (uri)">
              An external link
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="languages" type="array of object">
      Organizing by [languages](/core-concepts/navigation#localization)
    </ResponseField>

    <ResponseField name="versions" type="array of object">
      Organizing by [versions](/core-concepts/navigation#versions)
    </ResponseField>

    <ResponseField name="tabs" type="array of object">
      Organizing by [tabs](/core-concepts/navigation#divisions#tabs)
    </ResponseField>

    <ResponseField name="anchors" type="array of object">
      Organizing by [anchors](/core-concepts/navigation#divisions#anchors)
    </ResponseField>

    <ResponseField name="dropdowns" type="array of object">
      Organizing by [dropdowns](/core-concepts/navigation#divisions#dropdowns)
    </ResponseField>

    <ResponseField name="groups" type="array of object">
      Organizing by [groups](/core-concepts/navigation#pages#pages)
    </ResponseField>

    <ResponseField name="pages" type="array of string or object">
      An array of [page paths or groups](/core-concepts/navigation#pages#groups)
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="footer" type="object">
  Footer configurations

  <Expandable title="Footer">
    <ResponseField name="socials" type="object">
      An object in which each key is the name of a social media platform, and each value is the url to your profile. For example:

      ```json theme={null}
      {
        "x": "https://x.com/mintlify"
      }
      ```

      Valid property names: `x`, `website`, `facebook`, `youtube`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news`, `medium`, `telegram`, `twitter`, `x-twitter`, `earth-americas`, `bluesky`, `threads`, `reddit`, `podcast`
    </ResponseField>

    <ResponseField name="links" type="array of object">
      The links to be displayed in the footer

      <Expandable title="Links">
        <ResponseField name="header" type="string">
          The header title of the column

          Minimum length: 1
        </ResponseField>

        <ResponseField name="items" type="array of object">
          The links to be displayed in the column

          <Expandable title="Items">
            <ResponseField name="label" type="string">
              The label of the link

              Minimum length: 1
            </ResponseField>

            <ResponseField name="href" type="string (uri)">
              The url of the link
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="banner" type="object">
  Banner configurations

  <Expandable title="Banner">
    <ResponseField name="content" type="string">
      The content of the banner. This can be a string of text or a markdown string. For example:

      ```json theme={null}
      {
        "content": "🚀 Banner is live! [Learn more](mintlify.com)"
      }
      ```
    </ResponseField>

    <ResponseField name="dismissible" type="boolean">
      Whether the banner is dismissible. Defaults to `false`.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="redirects" type="array of object">
  <Expandable title="Redirects">
    <ResponseField name="source" type="string" />

    <ResponseField name="destination" type="string" />

    <ResponseField name="permanent" type="boolean" />
  </Expandable>
</ResponseField>

<ResponseField name="contextual" type="object">
  <Expandable title="Contextual">
    <ResponseField name="options" type="array of &#x22;copy&#x22; | &#x22;view&#x22; | &#x22;chatgpt&#x22; | &#x22;claude&#x22;">
      The options to be displayed in the contextual menu. The first option is the default option.

      * `copy`: Copy the current page as markdown to the clipboard
      * `view`: View the current page as markdown in a new tab
      * `chatgpt`: Feed the current page to ChatGPT
      * `claude`: Feed the current page to Claude

      <img alt="Contextual Menu" />

      <Warning>
        The contextual menu is only available on preview & production deployments.
      </Warning>
    </ResponseField>
  </Expandable>
</ResponseField>

### API Configurations

<ResponseField name="api" type="object">
  API reference configuration and playground settings

  <Expandable title="Api">
    <ResponseField name="openapi" type="string or array or object">
      A string or an array of strings of absolute or relative urls pointing to the OpenAPI file(s)

      <Expandable title="Openapi">
        <ResponseField name="source" type="string">
          Minimum length: 1
        </ResponseField>

        <ResponseField name="directory" type="string">
          no starting slash in the directory
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="asyncapi" type="string or array or object">
      A string or an array of strings of absolute or relative urls pointing to the AsyncAPI file(s)

      <Expandable title="Asyncapi">
        <ResponseField name="source" type="string">
          Minimum length: 1
        </ResponseField>

        <ResponseField name="directory" type="string" />
      </Expandable>
    </ResponseField>

    <ResponseField name="playground" type="object">
      Configurations for the API playground

      <Expandable title="Playground">
        <ResponseField name="display" type="&#x22;interactive&#x22; | &#x22;simple&#x22; | &#x22;none&#x22;">
          The display mode of the API playground. Defaults to `interactive`.
        </ResponseField>

        <ResponseField name="proxy" type="boolean">
          Whether to pass API requests through a proxy server. Defaults to `true`.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="examples" type="object">
      Configurations for the autogenerated API examples

      <Expandable title="Examples">
        <ResponseField name="languages" type="array of string">
          Example languages for the autogenerated API snippets
        </ResponseField>

        <ResponseField name="defaults" type="&#x22;required&#x22; | &#x22;all&#x22;">
          Whether to show optional parameters in api examples, defaults to `all`
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="mdx" type="object">
      Configurations for API pages generated from MDX files

      <Expandable title="Mdx">
        <ResponseField name="auth" type="object">
          Authentication configuration for the API

          <Expandable title="Auth">
            <ResponseField name="method" type="&#x22;bearer&#x22; | &#x22;basic&#x22; | &#x22;key&#x22; | &#x22;cobo&#x22;">
              Authentication method for the API
            </ResponseField>

            <ResponseField name="name" type="string">
              Authentication name for the API
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="server" type="string or array" />
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

### SEO & Search

<ResponseField name="seo" type="object">
  SEO indexing configurations

  <Expandable title="Seo">
    <ResponseField name="metatags" type="object">
      Meta tags added to every page. Must be a valid key-value pair. Possible options [here](https://www.mintlify.com/docs/settings/seo#supported-meta-tags)
    </ResponseField>

    <ResponseField name="indexing" type="&#x22;navigable&#x22; | &#x22;all&#x22;">
      Specify which pages to be indexed by search engines. Setting `navigable` indexes pages that are set in navigation, `all` indexes all pages. Defaults to `navigable`.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="search" type="object">
  Search display settings

  <Expandable title="Search">
    <ResponseField name="prompt" type="string">
      The prompt to be displayed in the search bar placeholder
    </ResponseField>
  </Expandable>
</ResponseField>

### Integrations

<ResponseField name="integrations" type="object">
  Configurations for official integrations

  <Expandable title="Integrations">
    <ResponseField name="amplitude" type="object">
      <Expandable title="Amplitude">
        <ResponseField name="apiKey" type="string" />
      </Expandable>
    </ResponseField>

    <ResponseField name="clearbit" type="object">
      <Expandable title="Clearbit">
        <ResponseField name="publicApiKey" type="string" />
      </Expandable>
    </ResponseField>

    <ResponseField name="fathom" type="object">
      <Expandable title="Fathom">
        <ResponseField name="siteId" type="string" />
      </Expandable>
    </ResponseField>

    <ResponseField name="frontchat" type="object">
      <Expandable title="Frontchat">
        <ResponseField name="snippetId" type="string">
          Minimum length: 6
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="ga4" type="object">
      <Expandable title="Ga4">
        <ResponseField name="measurementId" type="string matching ^G">
          Must match pattern: ^G
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="gtm" type="object">
      <Expandable title="Gtm">
        <ResponseField name="tagId" type="string matching ^G">
          Must match pattern: ^G
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="heap" type="object">
      <Expandable title="Heap">
        <ResponseField name="appId" type="string" />
      </Expandable>
    </ResponseField>

    <ResponseField name="hotjar" type="object">
      <Expandable title="Hotjar">
        <ResponseField name="hjid" type="string" />

        <ResponseField name="hjsv" type="string" />
      </Expandable>
    </ResponseField>

    <ResponseField name="intercom" type="object">
      <Expandable title="Intercom">
        <ResponseField name="appId" type="string">
          Minimum length: 6
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="koala" type="object">
      <Expandable title="Koala">
        <ResponseField name="publicApiKey" type="string">
          Minimum length: 2
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="logrocket" type="object">
      <Expandable title="Logrocket">
        <ResponseField name="appId" type="string" />
      </Expandable>
    </ResponseField>

    <ResponseField name="mixpanel" type="object">
      <Expandable title="Mixpanel">
        <ResponseField name="projectToken" type="string" />
      </Expandable>
    </ResponseField>

    <ResponseField name="osano" type="object">
      <Expandable title="Osano">
        <ResponseField name="scriptSource" type="string" />
      </Expandable>
    </ResponseField>

    <ResponseField name="pirsch" type="object">
      <Expandable title="Pirsch">
        <ResponseField name="id" type="string" />
      </Expandable>
    </ResponseField>

    <ResponseField name="posthog" type="object">
      <Expandable title="Posthog">
        <ResponseField name="apiKey" type="string matching ^phc\_">
          Must match pattern: ^phc\_
        </ResponseField>

        <ResponseField name="apiHost" type="string (uri)" />
      </Expandable>
    </ResponseField>

    <ResponseField name="plausible" type="object">
      <Expandable title="Plausible">
        <ResponseField name="domain" type="string" />

        <ResponseField name="server" type="string" />
      </Expandable>
    </ResponseField>

    <ResponseField name="segment" type="object">
      <Expandable title="Segment">
        <ResponseField name="key" type="string" />
      </Expandable>
    </ResponseField>

    <ResponseField name="telemetry" type="object">
      <Expandable title="Telemetry">
        <ResponseField name="enabled" type="boolean" />
      </Expandable>
    </ResponseField>

    <ResponseField name="cookies" type="object">
      <Expandable title="Cookies">
        <ResponseField name="key" type="string" />

        <ResponseField name="value" type="string" />
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

### Errors

<ResponseField name="errors" type="object">
  <Expandable title="Errors">
    <ResponseField name="404" type="object">
      <Expandable title="404">
        <ResponseField name="redirect" type="boolean">
          Whether to redirect to the home page, if the page is not found
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

## Validation

It is advised to include the following schema reference at the top of your docs.json file to ensure proper validation while editing:

```json theme={null}
{
  "$schema": "https://mintlify.com/docs.json",
  ...
}
```


# Quickstart
Source: https://maple.mintlify.app/quickstart

Start building awesome documentation in under 5 minutes

## Setup your development

Learn how to update your docs locally and and deploy them to the public.

### Edit and preview

<AccordionGroup>
  <Accordion icon="github" title="Clone your docs locally">
    During the onboarding process, we created a repository on your Github with
    your docs content. You can find this repository on our
    [dashboard](https://dashboard.mintlify.com). To clone the repository
    locally, follow these
    [instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
    in your terminal.
  </Accordion>

  <Accordion icon="rectangle-terminal" title="Preview changes">
    Previewing helps you make sure your changes look as intended. We built a
    command line interface to render these changes locally. 1. Install the
    [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the
    documentation changes locally with this command: `npm i -g mintlify`
    2\. Run the following command at the root of your documentation (where
    `docs.json` is): `mintlify dev`
  </Accordion>
</AccordionGroup>

### Deploy your changes

<AccordionGroup>
  <Accordion icon="message-bot" title="Install our Github app">
    Our Github app automatically deploys your changes to your docs site, so you
    don't need to manage deployments yourself. You can find the link to install on
    your [dashboard](https://dashboard.mintlify.com). Once the bot has been
    successfully installed, there should be a check mark next to the commit hash
    of the repo.
  </Accordion>

  <Accordion icon="rocket" title="Push your changes">
    [Commit and push your changes to
    Git](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push)
    for your changes to update in your docs site. If you push and don't see that
    the Github app successfully deployed your changes, you can also manually
    update your docs through our [dashboard](https://dashboard.mintlify.com).
  </Accordion>
</AccordionGroup>

## Update your docs

Add content directly in your files with MDX syntax and React components. You can use any of our components, or even build your own.

<CardGroup>
  <Card title="Style Your Docs" icon="paintbrush" href="essentials/settings">
    Add flair to your docs with personalized branding.
  </Card>

  <Card title="Add API Endpoints" icon="square-code" href="/api-reference/introduction">
    Implement your OpenAPI spec and enable API user interaction.
  </Card>

  <Card title="Integrate Analytics" icon="chart-mixed" href="https://www.mintlify.com/docs/integrations/analytics/overview">
    Draw insights from user interactions with your documentation.
  </Card>

  <Card title="Host on a Custom Domain" icon="browser" href="https://www.mintlify.com/docs/customize/custom-domain">
    Keep your docs on your own website's subdomain.
  </Card>
</CardGroup>


# Welcome to Maple
Source: https://maple.mintlify.app/welcome

This guide covers the prerequisite system requirements, provides step-by-step instructions for downloading and setting up the platform, and offers guidance on configuring your environment for optimal performance.

<img alt="Hero Light" />

<img alt="Hero Dark" />

## Setting up

The first step to world-class documentation is setting up your editing environments.

<CardGroup>
  <Card title="Edit Your Docs" icon="pen-to-square" href="https://www.mintlify.com/docs/quickstart">
    Get your docs set up locally for easy development
  </Card>

  <Card title="Preview Changes" icon="image" href="https://www.mintlify.com/docs/deploy/preview-deployments">
    Preview your changes before you push to make sure they're perfect
  </Card>
</CardGroup>

## Make it yours

Update your docs to your brand and add valuable content for the best user conversion.

<CardGroup>
  <Card title="Customize Style" icon="palette" href="https://www.mintlify.com/docs/organize/settings">
    Customize your docs to your company's colors and brands
  </Card>

  <Card title="Reference APIs" icon="code" href="https://www.mintlify.com/docs/api-playground/openapi-setup">
    Automatically generate endpoints from an OpenAPI spec
  </Card>

  <Card title="Add Components" icon="screwdriver-wrench" href="https://www.mintlify.com/docs/components/accordions">
    Build interactive features and designs to guide your users
  </Card>

  <Card title="Get Inspiration" icon="stars" href="https://mintlify.com/customers">
    Check out our showcase of our favorite documentation
  </Card>
</CardGroup>