Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions customize/custom-domain.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
---
title: "Custom domain"
description: "Host your documentation on a custom domain by configuring DNS settings and automatic TLS certificate provisioning."

Check warning on line 3 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L3

Spell out 'TLS', if it's unfamiliar to the audience.
keywords: ["custom domain setup", "DNS configuration", "CNAME records", "TLS certificates"]
---

<Card title="wefwe" icon="sparkles">
</Card>
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Placeholder card with nonsense title accidentally committed

High Severity

A <Card title="wefwe" icon="sparkles"> with a gibberish title was added to the top of the custom domain page. This appears to be test/debug content that was not meant to be committed. It renders a visible, empty card with the nonsensical title "wefwe" at the top of a production documentation page.

Fix in Cursor Fix in Web


To host your documentation on a custom domain:

1. Add your domain in your dashboard.
2. Configure DNS settings on your domain provider.
3. Allow time for DNS to propagate and TLS certificates to be automatically provisioned.

Check warning on line 14 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L14

Spell out 'TLS', if it's unfamiliar to the audience.

<Info>
Looking to set up a subpath like `example.com/docs`? See [/docs subpath](/deploy/docs-subpath).
Expand All @@ -22,13 +26,13 @@
<Frame>
<img
alt="The Custom domain setup page showing the field to enter your custom domain URL."
className="block dark:hidden"
src="/images/domain/add-custom-domain-light.png"
className="block hidden dark:block"
src="/images/domain/add-custom-domain-dark.png"
/>
<img
alt="The Custom domain setup page showing the field to enter your custom domain URL."
className="hidden dark:block"
src="/images/domain/add-custom-domain-dark.png"
className="block dark:hidden"
src="/images/domain/add-custom-domain-light.png"
/>
</Frame>

Expand All @@ -47,19 +51,19 @@

### DNS propagation

DNS changes typically take 1-24 hours to propagate globally, though it can take up to 48 hours in some cases. You can verify your DNS is configured correctly using [DNSChecker](https://dnschecker.org).

Check warning on line 54 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L54

In general, use active voice instead of passive voice ('is configured').

Once your DNS records are active, your documentation is first accessible via HTTP. HTTPS is available after Vercel provisions your TLS certificate.

Check warning on line 56 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L56

Spell out 'TLS', if it's unfamiliar to the audience.

### Automatic TLS provisioning

Check warning on line 58 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L58

'Automatic TLS provisioning' should use sentence-style capitalization.

Check warning on line 58 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L58

Spell out 'TLS', if it's unfamiliar to the audience.

Once your DNS records propagate and resolve correctly, Vercel automatically provisions a free SSL/TLS certificate for your domain using Let's Encrypt.

Check warning on line 60 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L60

Spell out 'TLS', if it's unfamiliar to the audience.

This typically completes within a few hours of DNS propagation, though it can take up to 24 hours in rare cases. Certificates are automatically renewed before expiration.

### CAA records

Check warning on line 64 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L64

'CAA records' should use sentence-style capitalization.

Check warning on line 64 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L64

Spell out 'CAA', if it's unfamiliar to the audience.

If your domain uses CAA (Certification Authority Authorization) records, you must authorize Let's Encrypt to issue certificates for your domain. Add the following CAA record to your DNS settings:

Check warning on line 66 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L66

Spell out 'CAA', if it's unfamiliar to the audience.

Check warning on line 66 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L66

Spell out 'CAA', if it's unfamiliar to the audience.

```text
0 issue "letsencrypt.org"
Expand All @@ -67,17 +71,17 @@

### Reserved paths

The `/.well-known/acme-challenge` path is reserved for certificate validation and cannot be redirected or rewritten. If you have configured redirects or rewrites for this path, certificate provisioning fails.

Check warning on line 74 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L74

In general, use active voice instead of passive voice ('is reserved').

Check warning on line 74 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L74

In general, use active voice instead of passive voice ('be redirected').

### Provider-specific settings

<AccordionGroup>
<Accordion title="Vercel verification">
If Vercel is your domain provider, you must add a verification `TXT` record. This information appears on your dashboard after submitting your custom domain, and is emailed to you.

Check warning on line 80 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L80

In general, use active voice instead of passive voice ('is emailed').
</Accordion>

<Accordion title="Cloudflare encryption mode">
If Cloudflare is your DNS provider, you must enable the "Full (strict)" mode for the SSL/TLS encryption setting. Additionally, disable "Always Use HTTPS" in your Edge Certificates settings. Cloudflare's HTTPS redirect blocks Let's Encrypt from validating your domain during certificate provisioning.

Check warning on line 84 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L84

Spell out 'TLS', if it's unfamiliar to the audience.
</Accordion>
</AccordionGroup>

Expand All @@ -103,4 +107,4 @@
"canonical": "https://docs.mintlify.com"
}
}
```
```
2 changes: 1 addition & 1 deletion deploy/authentication-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Authentication setup"
title: "Security"
description: "Control access to your documentation by authenticating users."
keywords: ['authentication', 'auth', 'OAuth', 'JWT', 'password']
---
Expand Down Expand Up @@ -104,7 +104,7 @@
* **Scopes** (optional): Permissions to request. Copy the **entire** scope string (for example, for a scope like `provider.users.docs`, copy the complete `provider.users.docs`). Use multiple scopes if you need different access levels.
* **Additional authorization parameters** (optional): Additional query parameters to add to the initial authorization request.
* **Token URL**: Your OAuth token exchange endpoint.
* **Info API URL** (optional): Endpoint on your server that Mintlify calls to retrieve user info. Required for group-based access control. If omitted, the OAuth flow only verifies identity.

Check warning on line 107 in deploy/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/authentication-setup.mdx#L107

Use 'endpoints?' instead of 'Endpoint'.
* **Logout URL** (optional): The native logout URL for your OAuth provider. When users log out, Mintlify validates the logout redirect against this configured URL for security. The redirect only succeeds if it exactly matches the configured `logoutUrl`. If you do not configure a logout URL, users redirect to `/login`. Mintlify redirects users with a `GET` request and does not append query parameters, so include any parameters (for example, `returnTo`) directly in the URL.
* **Redirect URL** (optional): The URL to redirect users to after authentication.
5. Click **Save changes**.
Expand Down
2 changes: 1 addition & 1 deletion es/deploy/authentication-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Configuración de autenticación"
title: "Seguridad"
description: "Controla el acceso a tu documentación mediante la autenticación de usuarios."
keywords: ['authentication', 'auth', 'OAuth', 'JWT', 'password']
---
Expand Down
2 changes: 1 addition & 1 deletion fr/deploy/authentication-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Configuration de l'authentification"
title: "Sécurité"
description: "Contrôlez l’accès à votre documentation en authentifiant les utilisateurs."
keywords: ['authentication', 'auth', 'OAuth', 'JWT', 'password']
---
Expand Down
27 changes: 12 additions & 15 deletions quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
title: "Quickstart"

Check warning on line 2 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L2

Use 'quickstarts?' instead of 'Quickstart'.
description: "Deploy your documentation site and make your first change."
keywords: ["quickstart","deploy","get started","first steps","tutorial","setup","onboarding"]
keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "setup", "onboarding"]
---

After you complete this guide, you'll have a live documentation site ready to customize and update.

## Before you begin
## Start here

Mintlify uses a docs-as-code approach to manage your documentation. Every page on your site has a corresponding file stored in your documentation <Tooltip tip="Your documentation's source code where all files and their history are stored. The web editor connects to your documentation repository to access and modify content, or you can edit files locally in your preferred IDE.">repository</Tooltip>.

When you connect your documentation repository to your project, you can work on your documentation locally or in the web editor and sync any changes to your remote repository.

<Tip>
Using an AI coding tool?

Copy the following prompt to add the Mintlify [skill](/ai/skillmd) and [MCP server](/ai/model-context-protocol) for better results when updating your documentation.
</Tip>

Expand All @@ -37,7 +37,7 @@

Replace `github.com` with `mintlify.com` in any public repository URL:

```
```text
https://mintlify.com/github-org/repo-name
```
</Tip>
Expand All @@ -62,15 +62,14 @@

<Frame>
<img
src="/images/quickstart/mintlify-domain-light.png"
alt="Overview page of the Mintlify dashboard."
className="block dark:hidden"
className="block hidden dark:block"
src="/images/quickstart/mintlify-domain-dark.png"
/>

<img
src="/images/quickstart/mintlify-domain-dark.png"
alt="Overview page of the Mintlify dashboard."
className="hidden dark:block"
className="block dark:hidden"
src="/images/quickstart/mintlify-domain-light.png"
/>
</Frame>

Expand All @@ -92,7 +91,6 @@
npm i -g mint
```


```bash pnpm
pnpm add -g mint
```
Expand Down Expand Up @@ -146,15 +144,14 @@

<Frame>
<img
src="/images/quickstart/hello-world-light.png"
alt="Introduction page open in the web editor with the description edited to say Hello world!."
className="block dark:hidden"
className="block hidden dark:block"
src="/images/quickstart/hello-world-dark.png"
/>

<img
src="/images/quickstart/hello-world-dark.png"
alt="Introduction page open in the web editor with the description edited to say Hello world!."
className="hidden dark:block"
className="block dark:hidden"
src="/images/quickstart/hello-world-light.png"
/>
</Frame>
</Step>
Expand Down
2 changes: 1 addition & 1 deletion zh/deploy/authentication-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "认证设置"
title: "安全"
description: "通过 OAuth、JWT 或密码等认证方式来控制对文档的访问权限。"
keywords: ['authentication', 'auth', 'OAuth', 'JWT', 'password']
---
Expand Down