From 51df29c1af87f222b20714b08376864f91b851d9 Mon Sep 17 00:00:00 2001 From: Franklin Koch Date: Wed, 23 Oct 2024 11:09:56 -0600 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20Update=20docs=20for=20url=5Ffold?= =?UTF-8?q?ers=20option?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/website-templates.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/website-templates.md b/docs/website-templates.md index 3bbd6c61c..3fff73307 100644 --- a/docs/website-templates.md +++ b/docs/website-templates.md @@ -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.