Skip to content

Commit

Permalink
📚 Update docs for url_folders option
Browse files Browse the repository at this point in the history
  • Loading branch information
fwkoch committed Oct 23, 2024
1 parent 93f576d commit 51df29c
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/website-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,10 @@ Below is a table of options for each theme bundled with MyST.
:heading-depth: 3
```

### Site URL Options

By default, MyST URLs only contain the file name for each page; folder structure is respected in the table of contents but is not reflected in URLs. If you would like to maintain nested folder structure in the URLs, you may provide the site option `url_folders: true`. This causes each folder in your MyST directory to become a path segment. For this feature to work correctly, your chosen theme must also support `url_folders` as an option. Both `book-theme` and `article-theme` bundled with MyST support this.

### Page Options

Depending on the option, these can also be controlled in the frontmatter on each page under the `site` key.
Expand Down

0 comments on commit 51df29c

Please sign in to comment.