You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: development.mdx
+17-14Lines changed: 17 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ description: 'Preview changes locally to update your docs'
33
33
mintlify dev
34
34
```
35
35
36
-
Alternatively, if you do not want to install Mintlify globally you can use a run script available:
36
+
If you prefer not to install Mintlify globally, you can use one of these available run scripts:
37
37
38
38
<CodeGroup>
39
39
```bash npm
@@ -51,28 +51,28 @@ Alternatively, if you do not want to install Mintlify globally you can use a run
51
51
</CodeGroup>
52
52
53
53
<Warning>
54
-
Yarn's "dlx" run script requires yarn version >2. See [here](https://yarnpkg.com/cli/dlx) for more information.
54
+
The Yarn "dlx" run script requires Yarn version >2. See the [Yarn documentation](https://yarnpkg.com/cli/dlx) for more information.
55
55
</Warning>
56
56
57
57
A local preview of your documentation will be available at `http://localhost:3000`.
58
58
59
59
### Custom Ports
60
60
61
-
By default, Mintlify uses port 3000. You can customize the port Mintlify runs on by using the `--port` flag. To run Mintlify on port 3333, for instance, use this command:
61
+
By default, Mintlify uses port 3000. You can customize the port by using the `--port` flag. For example, to run Mintlify on port 3333, use this command:
62
62
63
63
```bash
64
64
mintlify dev --port 3333
65
65
```
66
66
67
-
If you attempt to run Mintlify on a port that's already in use, it will use the next available port:
67
+
If the specified port is already in use, Mintlify will automatically use the next available port:
68
68
69
69
```md
70
70
Port 3000 is already in use. Trying 3001 instead.
71
71
```
72
72
73
73
## Mintlify Versions
74
74
75
-
Please note that each CLI release is associated with a specific version of Mintlify. If your local website doesn't align with the production version, please update the CLI:
75
+
Each CLI release is associated with a specific version of Mintlify. If your local website doesn't match the production version, update the CLI using one of these commands:
76
76
77
77
<CodeGroup>
78
78
@@ -92,15 +92,15 @@ Please note that each CLI release is associated with a specific version of Mintl
92
92
93
93
## Validating Links
94
94
95
-
The CLI can assist with validating reference links made in your documentation. To identify any broken links, use the following command:
95
+
The CLI includes a tool to help validate reference links in your documentation. To identify broken links, use this command:
96
96
97
97
```bash
98
98
mintlify broken-links
99
99
```
100
100
101
101
## Deployment
102
102
103
-
If the deployment is successful, you should see the following:
103
+
A successful deployment will show this confirmation screen:
104
104
105
105
<Frame>
106
106
<img
@@ -111,21 +111,24 @@ If the deployment is successful, you should see the following:
111
111
112
112
## Code Formatting
113
113
114
-
We suggest using extensions on your IDE to recognize and format MDX. If you're a VSCode user, consider the [MDX VSCode extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) for syntax highlighting, and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for code formatting.
114
+
We recommend using IDE extensions to properly handle and format MDX files. For VSCode users, we suggest:
115
+
116
+
- The [MDX VSCode extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) for syntax highlighting
117
+
-[Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for code formatting
115
118
116
119
## Troubleshooting
117
120
118
121
<AccordionGroup>
119
122
<Accordiontitle='Error: Could not load the "sharp" module using the darwin-arm64 runtime'>
120
123
121
-
This may be due to an outdated version of node. Try the following:
122
-
1. Remove the currently-installed version of mintlify: `npm remove -g mintlify`
123
-
2. Upgrade to Node v19 or higher.
124
-
3. Reinstall mintlify: `npm install -g mintlify`
124
+
This issue may be caused by an outdated version of Node.js. Try these steps:
125
+
1. Remove the currently-installed version of Mintlify: `npm remove -g mintlify`
126
+
2. Upgrade to Node.js v19 or higher
127
+
3. Reinstall Mintlify: `npm install -g mintlify`
125
128
</Accordion>
126
129
127
130
<Accordiontitle="Issue: Encountering an unknown error">
128
131
129
-
Solution: Go to the root of your device and delete the \~/.mintlify folder. Afterwards, run `mintlify dev` again.
132
+
Solution: Navigate to the root of your device and delete the ~/.mintlify folder. Then run `mintlify dev` again.
Copy file name to clipboardExpand all lines: settings/authentication.mdx
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: "Customize how your team can login to your Mintlify dashboard"
4
4
icon: 'user-unlock'
5
5
---
6
6
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!
7
+
Mintlify supports Single Sign-On (SSO) to your dashboard via SAML and OIDC. If you use Okta or Google Workspace, we have provider-specific documentation for setting up SSO. If you use another provider, please contact us!
8
8
9
9
<Note>
10
10
SSO functionality is available on our Enterprise plan. [Contact
@@ -20,18 +20,18 @@ Mintlify supports single sign-on to your dashboard via SAML and OIDC. If you use
20
20
Under `Applications`, click to create a new app integration using SAML 2.0.
21
21
</Step>
22
22
<Steptitle="Configure integration">
23
-
Enter the following:
24
-
* Single sign-on URL (provided by Mintlify)
23
+
Enter the following information:
24
+
* Single Sign-On URL (provided by Mintlify)
25
25
* Audience URI (provided by Mintlify)
26
26
* Name ID Format: `EmailAddress`
27
27
* Attribute Statements:
28
-
| Name | Name format | Value
28
+
| Name | Name Format | Value
29
29
| ---- | ----------- | -----
30
30
| `firstName` | Basic | `user.firstName` |
31
31
| `lastName` | Basic | `user.lastName` |
32
32
</Step>
33
33
<Steptitle="Send us your IdP information">
34
-
Once the application is set up, navigate to the sign-on tab and send us the metadata URL.
34
+
Once the application is set up, navigate to the Sign-On tab and send us the metadata URL.
35
35
We'll enable the connection from our side using this information.
36
36
</Step>
37
37
</Steps>
@@ -43,11 +43,11 @@ Mintlify supports single sign-on to your dashboard via SAML and OIDC. If you use
43
43
You should choose the `Web Application` application type.
44
44
</Step>
45
45
<Steptitle="Configure integration">
46
-
Select the authorization code grant type and enter the Redirect URI provided by Mintlify.
46
+
Select the Authorization Code grant type and enter the Redirect URI provided by Mintlify.
47
47
</Step>
48
48
<Steptitle="Send us your IdP information">
49
-
Once the application is set up, navigate to the General tab and locate the client ID & client secret.
50
-
Please securely provide us with these, along with your Okta instance URL (e.g. `<your-tenant-name>.okta.com`). You can send these via a service like 1Password or SendSafely.
49
+
Once the application is set up, navigate to the General tab and locate the Client ID and Client Secret.
50
+
Please securely provide us with these, along with your Okta instance URL (e.g.,`<your-tenant-name>.okta.com`). You can send these via a service like 1Password or SendSafely.
51
51
</Step>
52
52
</Steps>
53
53
</Tab>
@@ -65,23 +65,23 @@ Mintlify supports single sign-on to your dashboard via SAML and OIDC. If you use
65
65
</Frame>
66
66
</Step>
67
67
<Steptitle="Send us your IdP information">
68
-
Copy the provided SSO URL, Entity ID, and x509 certificate and send it to the Mintlify team.
68
+
Copy the provided SSO URL, Entity ID, and X.509 certificate and send them to the Mintlify team.
69
69
<Frame>
70
70

71
71
</Frame>
72
72
</Step>
73
73
<Steptitle="Configure integration">
74
-
On the Service provider details page, enter the following:
74
+
On the Service Provider details page, enter the following:
75
75
* ACS URL (provided by Mintlify)
76
76
* Entity ID (provided by Mintlify)
77
-
* Name ID format: `EMAIL`
77
+
* Name ID Format: `EMAIL`
78
78
* Name ID: `Basic Information > Primary email`
79
79
80
80
<Frame>
81
81

82
82
</Frame>
83
83
84
-
On the next page, enter the following attribute statements:
84
+
On the next page, enter the following Attribute Statements:
85
85
| Google Directory Attribute | App Attribute |
86
86
| -------------------------- | ------------- |
87
87
| `First name` | `firstName` |
@@ -92,4 +92,4 @@ Mintlify supports single sign-on to your dashboard via SAML and OIDC. If you use
0 commit comments