refactor: rename xref, add new information

Co-authored-by: Chris Holdgraf <choldgraf@gmail.com>
jupyter-book · May 24, 2024 · df8a5b7 · df8a5b7
1 parent e800723
commit df8a5b7
Show file tree

Hide file tree

Showing 4 changed files with 2 additions and 181 deletions.
diff --git a/docs/myst.yml b/docs/myst.yml
@@ -102,6 +102,7 @@ project:
       children:
         - file: website-templates.md
         - file: table-of-contents.md
+        - file: website-metadata.md
         # - file: themes-and-extensions.md
         - file: seo-and-social.md
         - file: accessibility-and-performance.md
@@ -137,7 +138,6 @@ project:
         - file: document-parts.md
         - file: settings.md
         - file: glossary.md
-        - file: xref.md
     - title: Contribute
       children:
         - file: contributing.md

diff --git a/docs/table-of-contents.md b/docs/table-of-contents.md
@@ -203,7 +203,7 @@ If a file is nested under a folder within your MyST project, for web-based expor
 - `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 in your site.
-See [](xref.md) for more details on how cross-references are stored.
+See [](website-metadata.md) for more details on how cross-references are stored.
 
 :::{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).

diff --git a/docs/web-metadata.md b/docs/web-metadata.md
diff --git a/docs/xref.md b/docs/xref.md