Skip to content

Commit 18699c6

Browse files
authored
Merge branch 'main' into dino475-patch-1
2 parents feb7ace + 25bbaac commit 18699c6

File tree

108 files changed

+2223
-804
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

108 files changed

+2223
-804
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
.DS_Store
22
node_modules
33
package-lock.json
4+
.idea/
5+
.vscode/

advanced/custom/css.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: 'Fully customize your documentation with custom CSS'
44
---
55

66
<Check>
7-
Custom CSS is available as an add-on to the [pro plan](https://mintlify.com/pricing).
7+
Custom CSS is available as an add-on to the [Pro plan](https://mintlify.com/pricing).
88
</Check>
99

1010
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.

advanced/custom/js.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: 'Add JavaScript functionality globally'
44
---
55

66
<Check>
7-
Custom JS is available as an add-on to the [pro plan](https://mintlify.com/pricing).
7+
Custom JS is available as an add-on to the [Pro plan](https://mintlify.com/pricing).
88
</Check>
99

1010
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.

advanced/rest-api/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Introduction
33
---
44

55
<Check>
6-
The Mintlify REST API is only available on the startup plan and above.
6+
The Mintlify REST API is only available on the [Pro plan and above](https://mintlify.com/pricing).
77
</Check>
88

99
Leverage the external API to programmatically trigger an update when desired.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
---
22
openapi: "POST /project/update/{projectId}"
3+
hideApiMarker: true
34
---
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
---
22
openapi: "GET /project/update-status/{statusId}"
3+
hideApiMarker: true
34
---

advanced/subpath/cloudflare.mdx

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "Host documentation at a /docs subpath using Cloudflare Workers"
55

66
import SubpathGatingSnippet from "/snippets/custom-subpath-gating.mdx";
77

8-
<SubpathGatingSnippet />
8+
<SubpathGatingSnippet platform="Cloudflare" />
99

1010
## Create Cloudflare Worker
1111

@@ -77,16 +77,8 @@ async function handleRequest(request) {
7777
// if no action found, play the regular request
7878
return await fetch(request);
7979
}
80-
81-
return await fetch(request);
8280
}
8381
```
8482

8583
Click on `Deploy` and wait for the changes to propagate (it can take up to a few
8684
hours).
87-
88-
## Reach out to Mintlify team
89-
90-
Once completing the Cloudflare setup, the Mintlify team will setup the
91-
subdirectory settings in your deployment. Reach out over
92-
[email](mailto:[email protected]).

advanced/subpath/route53-cloudfront.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "Host documentation at a /docs subdirectory using AWS services"
55

66
import SubpathGatingSnippet from "/snippets/custom-subpath-gating.mdx";
77

8-
<SubpathGatingSnippet />
8+
<SubpathGatingSnippet platform="AWS Services" />
99

1010
## Create Cloudfront Distribution
1111

advanced/subpath/vercel.mdx

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: "Vercel"
3+
description: "Host documentation at a /docs subpath using Vercel"
4+
---
5+
6+
import SubpathGatingSnippet from "/snippets/custom-subpath-gating.mdx";
7+
8+
<SubpathGatingSnippet platform="Vercel" />
9+
10+
## vercel.json Configuration
11+
12+
To host your documentation at a custom subpath using Vercel, you need to add the
13+
following configuration to your `vercel.json` file.
14+
15+
```json
16+
{
17+
"rewrites": [
18+
{
19+
"source": "/docs",
20+
"destination": "https://[subdomain].mintlify.dev/docs"
21+
},
22+
{
23+
"source": "/docs/:match*",
24+
"destination": "https://[subdomain].mintlify.dev/docs/:match*"
25+
}
26+
]
27+
}
28+
```
29+
30+
<Note>
31+
For more information, you can also refer to Vercel's offical guide on
32+
rewrites: [Project Configuration:
33+
Rewrites](https://vercel.com/docs/projects/project-configuration#rewrites)
34+
</Note>

advanced/user-auth/overview.mdx

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

0 commit comments

Comments
 (0)