🗂 Support url slugs with multiple path segments #489
Conversation
🦋 Changeset detectedLatest commit: 2cb7e55 The changes in this PR will be included in the next version bump. This PR includes changesets to release 14 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
| @@ -35,10 +35,16 @@ function nestToc(toc: Heading[]): NestedHeading[] { | |||
| return items; | |||
| } | |||
|
|
|||
| function pathnameMatchesHeading(pathname: string, heading: Heading, baseurl?: string) { | |||
| const headingPath = withBaseurl(heading.path, baseurl); | |||
| if (pathname && headingPath === `${pathname}/index`) return true; | |||
There was a problem hiding this comment.
There's a few small changes in here that allow index pages to be accessible at the folder-path url.
For example, the file folder1/folder2/index.md is available at /folder1/folder2 (and /folder1/folder2/index redirects back to /folder1/folder2).
| const config = await getConfig(); | ||
| const project = getProject(config, projectName ?? slug); | ||
| const project = getProject(config, first); |
There was a problem hiding this comment.
I learned about some strangeness in the article theme while making these changes: the article theme does not work correctly with project slugs. I think it is ok if project slugs just do not work with article theme, but we should make that more clear. For example, here we should not even try to load the project based on the URL; it should always just be the default single project.
However, for this PR, I tried as best as I could to keep parity with the old functionality.
| const search = await getMystSearchJson(); | ||
| if (!search) { | ||
| return json({ message: 'myst.search.json not found', status: 404 }, { status: 404 }); | ||
| } | ||
| return json(search); | ||
| } | ||
| const slug = [first, ...rest].join('.'); | ||
| const data = await getPage(request, { slug }).catch(() => null); |
There was a problem hiding this comment.
(Look at this for example - on this route, we do not mention anything about project. The other route should probably be the same way.)
| project: flat ? project : (project ?? slug), | ||
| slug: flat ? slug : project ? slug : undefined, | ||
| }); | ||
| const project = flat ? undefined : first; |
There was a problem hiding this comment.
In the book theme, all the project slug stuff works correctly.
|
@fwkoch has this been tested with notebooks in the mix, and specifically with notebooks in a subfolder being pages on the site and one or more outputs having been included as a figure? I'm curious about how any changes to the |
|
@stevejpurves - I have not tested these with notebook compute. I'll do that. |
|
We tested that the nested notebooks load at the correct jupyter path! |
This PR includes the theme updates required to support nested folder structures in URLs. See jupyter-book/mystmd#670
If MyST site content is built with the option
url_folders(see jupyter-book/mystmd#1601), the folder structure will be reflected as dot-delimited parts in the page slugs. With this PR, the themes will load the correct page based on slash-delimited URLs.For example, the file
folder1/folder2/page.mdwill be given the slugfolder1.folder2.pageand will be available at URL/folder1/folder2/page.