12 |
13 |
14 | In the details of the git check warning, you'll find the link to upgrade your plan. You can also upgrade your plan on the [dashboard](https://dashboard.mintlify.com) to enable unlimited editors to update your docs. Once you upgrade your plan, trigger a manual update or push another change to deploy your updates.
15 |
16 | Learn more about our pricing [here](https://mintlify.com/pricing).
17 |
--------------------------------------------------------------------------------
/advanced/dashboard/roles.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: "Roles"
3 | description: "Control access to your dashboard with roles."
4 | ---
5 |
6 | Mintlify provides two dashboard access levels: Editor and Admin.
7 |
8 | The following describes actions that are limited to the Admin role:
9 |
10 | | | Editor | Admin |
11 | | ----------------------- | :----: | :---: |
12 | | Update user roles | ❌ | ✅ |
13 | | Delete users | ❌ | ✅ |
14 | | Invite admin users | ❌ | ✅ |
15 | | Manage & update billing | ❌ | ✅ |
16 | | Update custom domain | ❌ | ✅ |
17 | | Update Git source | ❌ | ✅ |
18 | | Delete org | ❌ | ✅ |
19 |
20 | Other actions on the dashboard are available to both roles.
21 |
22 | You can invite as many admins as you want, but we recommend limiting admin
23 | access to users who need it.
24 |
--------------------------------------------------------------------------------
/advanced/dashboard/sso.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: "Single Sign-On (SSO)"
3 | description: "Customize how your team can login to your admin dashboard"
4 | ---
5 |
6 | 
31 |
32 |
33 | ### Enabling the contextual menu
34 |
35 | Add the `contextual` field to your `docs.json` and specify which options you want to include in your menu.
36 |
37 | ```json
38 | {
39 | "contextual": {
40 | "options": [
41 | "copy",
42 | "view",
43 | "chatgpt",
44 | "claude"
45 | ]
46 | }
47 | }
48 | ```
49 |
50 | ## /llms.txt
51 |
52 | The [/llms.txt file](https://llmstxt.org) is an industry standard that helps general-purpose LLMs index more efficiently, similar to how a sitemap helps search engines.
53 |
54 | Every documentation site automatically hosts an `/llms.txt` file at the root that lists all available pages in your documentation. AI tools can use this file to understand your documentation structure and find relevant content to user prompts.
55 |
56 | 
18 |
19 |
20 | ## Admin API key
21 |
22 | The Admin API key is used for the majority of the API. It is used to trigger updates via the [Update endpoint](/api-reference/update/trigger).
23 |
24 | ## Assistant API key
25 |
26 | The Assistant API allows you to embed the AI assistant experience grounded in your docs and continually kept up to date into any application of your choosing.
27 |
28 | Responses include citations so you can point your users to the right places they need to get help.
29 |
30 | 
11 |
12 |
13 | ## Captions
14 |
15 | You can add additional context to an image using the optional `caption` prop.
16 |
17 |
18 | 
19 |
20 |
21 | ## Props
22 |
23 | 
32 |
33 | ```
34 |
35 | ```jsx Frame with Captions
36 |
37 |
38 |
39 | ```
40 |
41 | 
15 |
16 |
17 | ## Changelog
18 |
19 | You can add anything here, like a screenshot, a code snippet, or a list of changes.
20 |
21 | #### Features
22 | - Responsive design
23 | - Sticky section for each changelog
24 | 
27 | 
32 |
33 |
34 | 
11 |
12 | ## Image
13 |
14 | Images are the most common way to add visual content to your documentation.
15 |
16 | ### Basics
17 |
18 | The [markdown syntax](https://www.markdownguide.org/basic-syntax/#images) lets you add images using the following code
19 |
20 | ```md
21 | 
22 | ```
23 |
35 | ```
36 |
37 | ### Disable Image Zoom
38 |
39 | To disable the default zoom on click for images, add the noZoom property to image embeds.
40 |
41 | ```html
42 |
43 | ```
44 |
45 | ### Linking Images
46 |
47 | To link an image, for example to create a button on your docs, encompass the image in a link with the `noZoom` property. Images in `a` tags will automatically have a pointer cursor.
48 |
49 | ```html
50 |
51 |
52 |
53 | ```
54 |
55 | ### Dark Mode
56 |
57 | To use separate images for light and dark mode, use Tailwind CSS to hide and show images.
58 |
59 | ```html
60 | 
61 | 
62 | ```
63 |
64 | ### Related
65 |
66 | For more information, we recommend the following sections:
67 |
68 | 88 | 89 |
12 | 
13 | {title}
14 | 15 | {description} 16 | 17 | 18 | ) 19 | } 20 | 21 |
22 |
--------------------------------------------------------------------------------
/installation.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: "Installation"
3 | description: "Install the CLI to preview and develop your docs locally"
4 | icon: "terminal"
5 | ---
6 |
7 |
23 | 
27 | 
31 |
32 |
33 |
34 |
27 |
31 |
32 |
35 |
57 |
58 | 36 | Documentation 37 | 38 |
39 | 40 |41 | Meet the next generation of documentation. AI-native, beautiful out-of-the-box, and built for developers. 42 | 43 |
44 | 45 |
46 |
55 |
56 | 
11 | 
15 |
16 | 31 | 32 |
27 | docs.json.}>
29 | In your `docs.json` file, add the URL from Stainless to the `openapi` field. See [OpenAPI Setup](/api-playground/openapi-setup) for more information.
30 | 
37 |
38 |
39 | ### Select MCP Clients
40 |
41 | After authentication, you'll choose which MCP clients to enable for your server:
42 |
43 |
44 | 
45 |
46 |
47 | Once configured, your MCP server is ready to use with the command provided in the terminal.
48 |
49 | ## Configuring Your MCP Server
50 |
51 | Now let's take a look at how to configure your MCP server.
52 |
53 | ### Default Functionality
54 |
55 | All MCP servers include the `search` tool by default, allowing users to query information across your entire documentation.
56 |
57 | ### Adding API Functions
58 |
59 | If you have an OpenAPI specification, you can expose specific endpoints as MCP tools by using the `x-mcp` extension at either the file or endpoint level.
60 |
61 | #### File-Level Configuration
62 |
63 | Enable MCP for all endpoints in a specification file:
64 |
65 | ```json
66 | {
67 | "openapi": "3.1.0",
68 | "x-mcp": {
69 | "enabled": true
70 | },
71 | // Other OpenAPI content
72 | }
73 | ```
74 |
75 | #### Endpoint-Level Configuration
76 |
77 | Enable MCP for specific endpoints only:
78 |
79 | ```json
80 | {
81 | "paths": {
82 | "/api/v1/users": {
83 | "x-mcp": {
84 | "enabled": true
85 | },
86 | // Endpoint configuration
87 | }
88 | }
89 | }
90 | ```
91 |
92 | ### Authentication Handling
93 |
94 | If your OpenAPI spec defines authentication using securitySchemes, these authentication methods will be automatically applied to your MCP server.
95 |
96 | ### Monitoring Your MCP Server
97 |
98 | After publishing your changes, you can view all available MCP tools in the **Available Tools** section on the MCP server page in your dashboard.
99 |
100 |
101 | 
102 | 
103 |
104 |
105 | ## Distribution
106 |
107 | ### User Installation
108 |
109 | Your users can install and use your MCP server with:
110 |
111 | ```bash
112 | npx mint-mcp add 
27 | 
32 |
33 |
34 | ## Verification with Vercel
35 |
36 | If Vercel happens to be your domain provider, you will have to add a verification `TXT` record. This information will show on your dashboard after submitting your custom domain, as well as be emailed to you.
37 |
38 | ## Configuring your DNS
39 |
40 | 1. Proceed to your domain's DNS settings on your domain provider's website.
41 | 2. Create a new DNS entry, inputting the following values:
42 |
43 | ```
44 | CNAME | docs | cname.vercel-dns.com.
45 | ```
46 |
47 |
48 | 
49 |
50 |
51 | If you are using Cloudflare for your DNS provider, you'll need to have the “full strict” security option enabled for the https setting.
52 |
53 | Please [contact support](mailto:sales@mintlify.com) if you don't see the custom domain set up after the above configuration.
54 |
--------------------------------------------------------------------------------
/settings/custom-scripts.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: 'Custom Scripts'
3 | description: 'Fully customize your documentation with custom CSS & JS'
4 | icon: "code"
5 | ---
6 |
7 | Add custom CSS & JS to your documentation to fully customize the look and feel.
8 |
9 | ## Custom CSS
10 |
11 | Add any number of CSS files to your repository and the defined class names will be applied and available across all of your MDX files.
12 |
13 | ### Adding style.css
14 |
15 | For example, you can add the following `style.css` file to customize the styling of the navbar and footer.
16 |
17 | ```css
18 | #navbar {
19 | background: "#fffff2";
20 | padding: 1rem;
21 | }
22 |
23 | footer {
24 | margin-top: 2rem;
25 | }
26 | ```
27 |
28 | ### Using Identifiers
29 |
30 | Mintlify has a set of common identifiers to help you tag important elements of the UI. Some, but not all are listed in the following:
31 |
32 | `#topbar-cta-button` `#navbar` `#sidebar` `#content-area` `#table-of-contents`
33 |
34 |