Skip to content

Commit

Permalink
docs: emphasize "index slug" convention (#9906)
Browse files Browse the repository at this point in the history
  • Loading branch information
Josh-Cena authored Mar 4, 2024
1 parent 2152572 commit 324c853
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion website/docs/guides/docs/docs-create-doc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,21 @@ The ID is used to refer to a document when hand-writing sidebars, or when using

### Doc URLs {#doc-urls}

By default, a document's URL location is its file path relative to the `docs` folder. Use the `slug` front matter to change a document's URL.
By default, a document's URL location is its file path relative to the `docs` folder, with a few exceptions. Namely, if a file is named one the following, the file name won't be included in the URL:

- Named as `index` (case-insensitive): `docs/Guides/index.md`
- Named as `README` (case-insensitive): `docs/Guides/README.mdx`
- Same name as parent folder: `docs/Guides/Guides.md`

In all cases, the default slug would only be `/Guides`, without the `/index`, `/README`, or duplicate `/Guides` segment.

:::note

This convention is exactly the same as [the category index convention](./sidebar/autogenerated.mdx#category-index-convention). However, the `isCategoryIndex` configuration does _not_ affect the document URL.

:::

Use the `slug` front matter to change a document's URL.

For example, suppose your site structure looks like this:

Expand Down

0 comments on commit 324c853

Please sign in to comment.