Skip to content

Commit 8f8c3c3

Browse files
committed
Update docs
1 parent d7b66de commit 8f8c3c3

File tree

7 files changed

+42
-53
lines changed

7 files changed

+42
-53
lines changed

advanced/custom/js.mdx

Lines changed: 0 additions & 28 deletions
This file was deleted.

settings/add-members.mdx renamed to advanced/dashboard/permissions.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: 'Editor Permissions'
33
description: 'Allow more members of your team to update your docs'
4-
icon: 'user-group-simple'
54
---
65

76
The team member who created your initial docs will have update access to your docs, as long as they push to your documentation repo with the same GitHub account that was used while signing up for Mintlify.

settings/authentication.mdx renamed to advanced/dashboard/sso.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
title: "Single Sign-On (SSO)"
3-
description: "Customize how your team can login to your Mintlify dashboard"
4-
icon: 'user-unlock'
3+
description: "Customize how your team can login to your admin dashboard"
54
---
65

7-
Mintlify supports single sign-on to your dashboard via SAML and OIDC. If you use Okta or Google Workspace, we have provider-specific documentation for setting up SSO, but if you use another provider, please contact us!
6+
Use single sign-on to your dashboard via SAML and OIDC. If you use Okta or Google Workspace, we have provider-specific documentation for setting up SSO, but if you use another provider, please contact us!
87

98
<Note>
109
SSO functionality is available on our Enterprise plan. [Contact

api-playground/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'Interactive Playground'
2+
title: 'Playground'
33
description: 'Enable users to interact with your API'
44
openapi: 'GET /plants/{id}'
55
hideApiMarker: true

docs.json

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,8 @@
7979
"pages": [
8080
"settings/custom-domain",
8181
"settings/seo",
82+
"settings/custom-scripts",
8283
"settings/broken-links",
83-
"settings/add-members",
84-
"settings/authentication",
8584
"settings/github",
8685
"settings/gitlab",
8786
"settings/ci",
@@ -91,11 +90,6 @@
9190
{
9291
"group": "Advanced",
9392
"pages": [
94-
{
95-
"group": "Custom Scripts",
96-
"icon": "code",
97-
"pages": ["advanced/custom/css", "advanced/custom/js"]
98-
},
9993
{
10094
"group": "Custom Subdirectory",
10195
"icon": "folder",
@@ -135,6 +129,11 @@
135129
"settings/authentication-personalization/sending-data"
136130
]
137131
},
132+
{
133+
"group": "Dashboard Access",
134+
"icon": "house-lock",
135+
"pages": ["advanced/dashboard/sso", "advanced/dashboard/permissions"]
136+
},
138137
{
139138
"group": "REST API",
140139
"icon": "brackets-curly",
@@ -257,9 +256,6 @@
257256
}
258257
]
259258
},
260-
"styling": {
261-
"codeblocks": "system"
262-
},
263259
"logo": {
264260
"light": "/logo/light.svg",
265261
"dark": "/logo/dark.svg",

settings/ci.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: CI Checks
3-
description: "Use Mintlify's CI tools to lint your docs"
3+
description: "Add broken links, linting, and grammar checks to the updating process"
44
icon: 'circle-check'
55
---
66

77
<Warning>
8-
This feature is only available for customers on paid plans using GitHub. If you'd like it enabled for other platforms, please provide [feedback](https://feedback.mintlify.com/roadmap).
8+
This feature is only available for customers on paid plans and for GitHub. Support for other platforms is coming soon.
99
</Warning>
1010

11-
Mintlify is capable of using its installed Github App to lint your docs for errors, and give you warnings before you deploy.
11+
Use CI checks to lint your docs for errors, and give you warnings before you deploy.
1212

1313
## Installation
1414

advanced/custom/css.mdx renamed to settings/custom-scripts.mdx

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
---
2-
title: 'Custom CSS'
3-
description: 'Fully customize your documentation with custom CSS'
2+
title: 'Custom CSS & JS'
3+
description: 'Fully customize your documentation with custom CSS & JS'
4+
icon: 'code'
45
---
56

6-
<Check>
7-
Custom CSS is available as an add-on to the [Pro plan](https://mintlify.com/pricing).
8-
</Check>
7+
Add custom CSS & JS to your documentation to fully customize the look and feel.
8+
9+
## Custom CSS
910

1011
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.
1112

12-
## Adding style.css
13+
### Adding style.css
1314

1415
For example, you can add the following `style.css` file to customize the styling of the navbar and footer.
1516

@@ -24,7 +25,7 @@ footer {
2425
}
2526
```
2627

27-
## Using Identifiers
28+
### Using Identifiers
2829

2930
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:
3031

@@ -39,3 +40,25 @@ Mintlify has a set of common identifiers to help you tag important elements of t
3940
References and the styling of common elements are subject to change as the
4041
platform evolves. Please use custom styling with caution.
4142
</Warning>
43+
44+
## Custom JS
45+
46+
Custom JS allows you to add custom executable code globally. It is the equivalent of adding a `<script>` tag with JS code into every page.
47+
48+
### Adding Custom JavaScript
49+
50+
Any `.js` file inside the content directory of your docs will be included in every documentation page. For example, you can add the following `ga.js` file to enable [Google Analytics](https://marketingplatform.google.com/about/analytics) across the entire documentation.
51+
52+
```js
53+
window.dataLayer = window.dataLayer || [];
54+
function gtag() {
55+
dataLayer.push(arguments);
56+
}
57+
gtag('js', new Date());
58+
59+
gtag('config', 'TAG_ID');
60+
```
61+
62+
<Warning>
63+
Please use with caution to not introduce security vulnerabilities.
64+
</Warning>

0 commit comments

Comments
 (0)