Skip to content
Merged
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
34 changes: 34 additions & 0 deletions editor/configurations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,40 @@ Document your API endpoints.
- **Playground display**: Choose to display the interactive API playground, simple API playground, or no API playground.
- **Proxy server**: Enable or disable the proxy server for API requests.

## Manage redirects

Use the **Redirects** section to add, edit, search, and remove redirects without manually editing your `docs.json` file. Redirects send users from old URLs to new ones, which is useful when you rename pages or restructure your documentation. For more information about redirect behavior, see [Redirects](/create/redirects).

Each redirect has the following fields:

- **Source**: The path to redirect from, like `/old-path`. Supports wildcards.
- **Destination**: The path to redirect to, like `/new-path`.
- **Status**: The HTTP status code for the redirect.
- `308`: Permanent redirect. Use this for content that has moved permanently. This is the default status.
- `307`: Temporary redirect. Use this when the move is temporary.

<Frame>
<img
src="/images/editor/redirects-light.png"
alt="Redirects menu in the editor."
className="block dark:hidden"
/>
<img
src="/images/editor/redirects-dark.png"
alt="Redirects menu in the editor."
className="hidden dark:block"
/>
</Frame>

To add a redirect:
1. Click **Add redirect**
2. Enter the source and destination.
3. Click **Save**.

To edit or remove an existing redirect:
1. Hover over the redirect.
2. Click the pencil icon to edit or the trash icon to remove.

## Additional page behaviors

- **404 pages**: Customize 404 pages and set up redirect behavior.
Expand Down
Binary file added images/editor/redirects-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/editor/redirects-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading