From e304b65fec8dbe15192139a01e3f40a7f266a191 Mon Sep 17 00:00:00 2001 From: Rowan Cockett Date: Wed, 17 Apr 2024 08:41:18 -0600 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=96=20Update=20docs=20around=20nesting?= =?UTF-8?q?=20of=20files=20(#1120)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See #670 --- docs/table-of-contents.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/table-of-contents.md b/docs/table-of-contents.md index 6331bcd4b..40cf1097c 100644 --- a/docs/table-of-contents.md +++ b/docs/table-of-contents.md @@ -114,10 +114,12 @@ parts: ## Nesting of Files in URLs -You can have any level of nesting in a file-system of your project, however, when it is displayed in the URL in `mystmd`, these nesting will be flattened to have a single “slug” that is contained in the project. +MyST can have any level of nesting in a file-system of your project, however, when it is displayed in the URL in `mystmd`, these nesting will be flattened to have a single "slug" that is contained in the project. - `project/folder2/01_my_article.md` becomes `project/my-article` All internal links will automatically be updated, and there is a `file` property that is exported as metadata. Add `.json` to the end of any url in your site to see the full data of the page. -If you want to have URL nesting, we suggest splitting your site up into different "projects", which are simply other `myst.yml` definitions and can all exist in a single Git repository, for example. Each project has its own metadata, and can for example define GitHub links, or any other [](./frontmatter.md) that will cascade to the various documents in that project. +:::{note} URL Nesting +URL nesting that matches the folder structure is a requested feature that is being tracked in [#670](https://github.com/executablebooks/mystmd/issues/670). +:::