Skip to content
Open
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
12 changes: 11 additions & 1 deletion deploy/authentication-setup.mdx
Original file line number Diff line number Diff line change
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 Expand Up @@ -274,7 +274,17 @@

## Make pages public

When using authentication, all pages require authentication to access by default. You can make specific pages viewable without authentication at the page or group level with the `public` property.
When using authentication, all pages require authentication to access by default. You can change this default and make specific pages viewable without authentication using the `public` property at the site or page level.

### Site-wide default

To make all pages public by default, set `"public": true` at the top level of your `docs.json`. Individual pages can then override this with `"public": false` in their frontmatter to require authentication for specific content.

```json docs.json
{
"public": true
}
```

### Individual pages

Expand Down
19 changes: 15 additions & 4 deletions organize/navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -120,11 +120,11 @@

Use the `expanded` property to control the default state of a nested group in the navigation sidebar.

- `expanded: true`: Group is expanded by default.
- `expanded: false` or omitted: Group is collapsed by default.
- `expanded: true`: Group expands by default.
- `expanded: false` or omitted: Group collapses by default.

<Note>
The `expanded` property only affects nested groups--groups within groups. Top-level groups are always expanded and cannot be collapsed.
The `expanded` property only affects nested groups--groups within groups. Top-level groups always expand and cannot collapse.
</Note>

```json
Expand Down Expand Up @@ -334,12 +334,23 @@

In the `navigation` object, `products` is an array where each entry is an object that requires a `product` field and can contain other navigation fields such as groups, pages, icons, or links to external pages.

Each product supports the following properties:

| Property | Type | Description |
|---|---|---|
| `product` | string | **Required.** The identifier for the product. |
| `name` | string | Label shown in the switcher when a user selects this product. Defaults to `product` if not set. |
| `description` | string | Short description of the product. |
| `icon` | string | Icon displayed next to the product name. |
| `hidden` | boolean | When `true`, hides the product from navigation while keeping its pages accessible by URL. |

```json
{
"navigation": {
"products": [
{
"product": "Core API",
"product": "core-api",
"name": "Core API",
"description": "Core API description",
"icon": "api",
"groups": [
Expand Down Expand Up @@ -380,9 +391,9 @@
}
```

## Dropdowns

Check warning on line 394 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L394

Use 'dropdowns?' instead of 'Dropdowns'.

Dropdowns are an expandable menu at the top of your sidebar navigation. Each item in a dropdown directs to a section of your documentation.

Check warning on line 396 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L396

Use 'dropdowns?' instead of 'Dropdowns'.

<img
className="block dark:hidden pointer-events-none"
Expand Down Expand Up @@ -950,9 +961,9 @@

</CodeGroup>

## Breadcrumbs

Check warning on line 964 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L964

Use 'breadcrumbs?' instead of 'Breadcrumbs'.

Breadcrumbs display the full navigation path at the top of pages. Some themes have breadcrumbs enabled by default and others do not. You can control whether breadcrumbs display on your site using the `styling` property in your `docs.json`.

Check warning on line 966 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L966

Use 'breadcrumbs?' instead of 'Breadcrumbs'.

<CodeGroup>

Expand Down
14 changes: 13 additions & 1 deletion organize/settings-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
| `redirects` | array | No | None |
| `variables` | object | No | None |
| `metadata.timestamp` | boolean | No | `false` |
| `public` | boolean | No | `false` |
| `errors.404.redirect` | boolean | No | `true` |
| `api.openapi` | string or array or object | No | None |
| `api.asyncapi` | string or array or object | No | None |
Expand Down Expand Up @@ -155,7 +156,7 @@

##### `navigation.global.dropdowns`

Dropdown menus.

Check warning on line 159 in organize/settings-reference.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings-reference.mdx#L159

Use 'dropdowns?' instead of 'Dropdown'.

**Type:** array of object—each with: `dropdown` (string, required), `icon` (string), `iconType` (string), `hidden` (boolean), `href` (string uri, required)

Expand All @@ -177,7 +178,7 @@

Product switcher in the global nav.

**Type:** array of object—each with: `product` (string, required), `description` (string), `icon` (string), `iconType` (string)
**Type:** array of object—each with: `product` (string, required), `name` (string), `description` (string), `icon` (string), `hidden` (boolean)

#### `navigation.languages`

Expand Down Expand Up @@ -207,7 +208,7 @@

#### `navigation.dropdowns`

Dropdown menus.

Check warning on line 211 in organize/settings-reference.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings-reference.mdx#L211

Use 'dropdowns?' instead of 'Dropdown'.

**Type:** array of object—see `navigation.global.dropdowns` for shape.

Expand Down Expand Up @@ -671,6 +672,17 @@

---

### `public`

Whether all pages are publicly accessible by default when a site requires [authentication](/deploy/authentication-setup).

When `true`, all pages are visible without authentication unless a specific group or page overrides this with `"public": false`. When `false` or omitted, all pages require authentication unless explicitly marked public.

**Type:** boolean
**Default:** `false`

---

### `errors`

Error page settings.
Expand Down
Loading