From e2ae7d0c86701fa4e9f68e77d87bfb6009d4a900 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 18 Oct 2025 07:33:34 +0000 Subject: [PATCH 01/22] =?UTF-8?q?=F0=9F=9A=80=20Release?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .changeset/three-donkeys-enjoy.md | 7 ------- package-lock.json | 24 ++++++++++++------------ packages/markdown-it-myst/CHANGELOG.md | 6 ++++++ packages/markdown-it-myst/package.json | 2 +- packages/myst-directives/CHANGELOG.md | 2 ++ packages/myst-directives/package.json | 2 +- packages/myst-parser/CHANGELOG.md | 13 +++++++++++++ packages/myst-parser/package.json | 12 ++++++------ packages/myst-roles/CHANGELOG.md | 2 ++ packages/myst-roles/package.json | 2 +- packages/myst-to-html/CHANGELOG.md | 6 ++++++ packages/myst-to-html/package.json | 2 +- packages/myst-transforms/CHANGELOG.md | 7 +++++++ packages/myst-transforms/package.json | 4 ++-- 14 files changed, 60 insertions(+), 31 deletions(-) delete mode 100644 .changeset/three-donkeys-enjoy.md diff --git a/.changeset/three-donkeys-enjoy.md b/.changeset/three-donkeys-enjoy.md deleted file mode 100644 index 484fe7fe73..0000000000 --- a/.changeset/three-donkeys-enjoy.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -'myst-parser': minor -'markdown-it-myst': patch -'myst-to-html': patch ---- - -Update MarkdownIt to 13 for all dependencies, add types to dependencieswq diff --git a/package-lock.json b/package-lock.json index 64416c025c..522a4c9e80 100644 --- a/package-lock.json +++ b/package-lock.json @@ -15304,7 +15304,7 @@ } }, "packages/markdown-it-myst": { - "version": "1.0.12", + "version": "1.0.13", "license": "MIT", "dependencies": { "js-yaml": "^4.1.0", @@ -15577,7 +15577,7 @@ } }, "packages/myst-directives": { - "version": "1.5.17", + "version": "1.6.0", "license": "MIT", "dependencies": { "classnames": "^2.3.2", @@ -15761,7 +15761,7 @@ } }, "packages/myst-parser": { - "version": "1.5.17", + "version": "1.6.0", "license": "MIT", "dependencies": { "@types/markdown-it": "^13.0.0", @@ -15772,12 +15772,12 @@ "markdown-it-dollarmath": "^0.5.0", "markdown-it-footnote": "^4.0.0", "markdown-it-front-matter": "^0.2.3", - "markdown-it-myst": "1.0.12", + "markdown-it-myst": "1.0.13", "markdown-it-myst-extras": "0.3.0", "markdown-it-task-lists": "^2.1.1", "myst-common": "^1.8.3", - "myst-directives": "^1.5.17", - "myst-roles": "^1.5.17", + "myst-directives": "^1.6.0", + "myst-roles": "^1.6.0", "myst-spec": "^0.0.5", "unified": "^10.1.1", "unist-builder": "^3.0.0", @@ -15793,13 +15793,13 @@ "@types/js-yaml": "^4.0.5", "@types/mdast": "^3.0.10", "js-yaml": "^4.1.0", - "myst-to-html": "^1.5.17", - "myst-transforms": "^1.3.40", + "myst-to-html": "^1.6.0", + "myst-transforms": "^1.3.41", "rehype-stringify": "^9.0.3" } }, "packages/myst-roles": { - "version": "1.5.17", + "version": "1.6.0", "license": "MIT", "dependencies": { "myst-common": "^1.8.3", @@ -15859,7 +15859,7 @@ } }, "packages/myst-to-html": { - "version": "1.5.17", + "version": "1.6.0", "license": "MIT", "dependencies": { "@types/markdown-it": "^13.0.1", @@ -16063,7 +16063,7 @@ } }, "packages/myst-transforms": { - "version": "1.3.40", + "version": "1.3.41", "license": "MIT", "dependencies": { "doi-utils": "^2.0.5", @@ -16077,7 +16077,7 @@ "myst-frontmatter": "^1.8.3", "myst-spec": "^0.0.5", "myst-spec-ext": "^1.8.3", - "myst-to-html": "1.5.17", + "myst-to-html": "1.6.0", "rehype-parse": "^8.0.4", "rehype-remark": "^9.1.2", "unified": "^10.0.0", diff --git a/packages/markdown-it-myst/CHANGELOG.md b/packages/markdown-it-myst/CHANGELOG.md index 4ac316b8f2..adf2ef6219 100644 --- a/packages/markdown-it-myst/CHANGELOG.md +++ b/packages/markdown-it-myst/CHANGELOG.md @@ -1,5 +1,11 @@ # markdown-it-myst +## 1.0.13 + +### Patch Changes + +- cd8ee79: Update MarkdownIt to 13 for all dependencies, add types to dependencieswq + ## 1.0.12 ### Patch Changes diff --git a/packages/markdown-it-myst/package.json b/packages/markdown-it-myst/package.json index 24d385472d..0e6f29ea0c 100644 --- a/packages/markdown-it-myst/package.json +++ b/packages/markdown-it-myst/package.json @@ -1,6 +1,6 @@ { "name": "markdown-it-myst", - "version": "1.0.12", + "version": "1.0.13", "sideEffects": false, "license": "MIT", "description": "markdown-it tokenizer for MyST roles and directives", diff --git a/packages/myst-directives/CHANGELOG.md b/packages/myst-directives/CHANGELOG.md index 4717ae46f4..91469f6619 100644 --- a/packages/myst-directives/CHANGELOG.md +++ b/packages/myst-directives/CHANGELOG.md @@ -1,5 +1,7 @@ # myst-directives +## 1.6.0 + ## 1.5.17 ### Patch Changes diff --git a/packages/myst-directives/package.json b/packages/myst-directives/package.json index 14637a8244..1922353590 100644 --- a/packages/myst-directives/package.json +++ b/packages/myst-directives/package.json @@ -1,6 +1,6 @@ { "name": "myst-directives", - "version": "1.5.17", + "version": "1.6.0", "sideEffects": false, "license": "MIT", "description": "Default directive definitions for MyST", diff --git a/packages/myst-parser/CHANGELOG.md b/packages/myst-parser/CHANGELOG.md index 3e35371c1c..d49ec3927e 100644 --- a/packages/myst-parser/CHANGELOG.md +++ b/packages/myst-parser/CHANGELOG.md @@ -1,5 +1,18 @@ # myst-parser +## 1.6.0 + +### Minor Changes + +- cd8ee79: Update MarkdownIt to 13 for all dependencies, add types to dependencieswq + +### Patch Changes + +- Updated dependencies [cd8ee79] + - markdown-it-myst@1.0.13 + - myst-roles@1.6.0 + - myst-directives@1.6.0 + ## 1.5.17 ### Patch Changes diff --git a/packages/myst-parser/package.json b/packages/myst-parser/package.json index 2ac6a691e3..05ede6db0d 100644 --- a/packages/myst-parser/package.json +++ b/packages/myst-parser/package.json @@ -1,6 +1,6 @@ { "name": "myst-parser", - "version": "1.5.17", + "version": "1.6.0", "description": "Markdown parser for MyST markdown in JavaScript", "author": "Rowan Cockett ", "homepage": "https://github.com/jupyter-book/mystmd/tree/main/packages/myst-parser", @@ -49,12 +49,12 @@ "markdown-it-dollarmath": "^0.5.0", "markdown-it-footnote": "^4.0.0", "markdown-it-front-matter": "^0.2.3", - "markdown-it-myst": "1.0.12", + "markdown-it-myst": "1.0.13", "markdown-it-myst-extras": "0.3.0", "markdown-it-task-lists": "^2.1.1", "myst-common": "^1.8.3", - "myst-directives": "^1.5.17", - "myst-roles": "^1.5.17", + "myst-directives": "^1.6.0", + "myst-roles": "^1.6.0", "myst-spec": "^0.0.5", "unified": "^10.1.1", "unist-builder": "^3.0.0", @@ -70,8 +70,8 @@ "@types/js-yaml": "^4.0.5", "@types/mdast": "^3.0.10", "js-yaml": "^4.1.0", - "myst-to-html": "^1.5.17", - "myst-transforms": "^1.3.40", + "myst-to-html": "^1.6.0", + "myst-transforms": "^1.3.41", "rehype-stringify": "^9.0.3" } } diff --git a/packages/myst-roles/CHANGELOG.md b/packages/myst-roles/CHANGELOG.md index 5bd689e143..ff4d85e8d9 100644 --- a/packages/myst-roles/CHANGELOG.md +++ b/packages/myst-roles/CHANGELOG.md @@ -1,5 +1,7 @@ # myst-roles +## 1.6.0 + ## 1.5.17 ### Patch Changes diff --git a/packages/myst-roles/package.json b/packages/myst-roles/package.json index 15889f17cd..71b7960b3c 100644 --- a/packages/myst-roles/package.json +++ b/packages/myst-roles/package.json @@ -1,6 +1,6 @@ { "name": "myst-roles", - "version": "1.5.17", + "version": "1.6.0", "sideEffects": false, "license": "MIT", "description": "Default role definitions for MyST", diff --git a/packages/myst-to-html/CHANGELOG.md b/packages/myst-to-html/CHANGELOG.md index ab2a64d314..02321f2eef 100644 --- a/packages/myst-to-html/CHANGELOG.md +++ b/packages/myst-to-html/CHANGELOG.md @@ -1,5 +1,11 @@ # myst-to-html +## 1.6.0 + +### Patch Changes + +- cd8ee79: Update MarkdownIt to 13 for all dependencies, add types to dependencieswq + ## 1.5.17 ### Patch Changes diff --git a/packages/myst-to-html/package.json b/packages/myst-to-html/package.json index 88c35e6bb6..aabcc7e4e3 100644 --- a/packages/myst-to-html/package.json +++ b/packages/myst-to-html/package.json @@ -1,6 +1,6 @@ { "name": "myst-to-html", - "version": "1.5.17", + "version": "1.6.0", "description": "Export from MyST mdast to HTML", "author": "Franklin Koch ", "homepage": "https://github.com/jupyter-book/mystmd/tree/main/packages/myst-to-html", diff --git a/packages/myst-transforms/CHANGELOG.md b/packages/myst-transforms/CHANGELOG.md index 11222cecf5..fbd81ea051 100644 --- a/packages/myst-transforms/CHANGELOG.md +++ b/packages/myst-transforms/CHANGELOG.md @@ -1,5 +1,12 @@ # myst-transforms +## 1.3.41 + +### Patch Changes + +- Updated dependencies [cd8ee79] + - myst-to-html@1.6.0 + ## 1.3.40 ### Patch Changes diff --git a/packages/myst-transforms/package.json b/packages/myst-transforms/package.json index 4860a788a9..029958e329 100644 --- a/packages/myst-transforms/package.json +++ b/packages/myst-transforms/package.json @@ -1,6 +1,6 @@ { "name": "myst-transforms", - "version": "1.3.40", + "version": "1.3.41", "sideEffects": false, "type": "module", "exports": "./dist/index.js", @@ -30,7 +30,7 @@ "myst-frontmatter": "^1.8.3", "myst-spec": "^0.0.5", "myst-spec-ext": "^1.8.3", - "myst-to-html": "1.5.17", + "myst-to-html": "1.6.0", "rehype-parse": "^8.0.4", "rehype-remark": "^9.1.2", "unified": "^10.0.0", From 09348e4afd5a4f866ad7ef95d87a441595eeb065 Mon Sep 17 00:00:00 2001 From: FreekPols Date: Sat, 18 Oct 2025 09:53:54 +0200 Subject: [PATCH 02/22] document no-pdf block --- docs/creating-pdf-documents.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/creating-pdf-documents.md b/docs/creating-pdf-documents.md index fa50165d29..0865ed2347 100644 --- a/docs/creating-pdf-documents.md +++ b/docs/creating-pdf-documents.md @@ -239,7 +239,13 @@ Please consider [contributing your template](/jtex/contribute-a-template) to the ## Excluding Content from Specific Exports -If you have a block or notebook cell that you do not want to render to your $\LaTeX$ output, add the `no-tex` tag to the cell. Similarly, to exclude a cell from Typst, use `no-typst`. To exclude a cell from both formats, use `no-pdf`. +If you have a [block](./blocks.md) or notebook cell that you do not want to render to your $\LaTeX$ output, add the `no-tex` tag to the cell. Similarly, to exclude a cell from Typst, use `no-typst`. To exclude a cell from both formats, use `no-pdf`. + +```markdown ++++{no-pdf} +This will not be in the pdf ++++ +``` ## Including Content with Specific Exports From 64d134de3b1d79737cb2c43a4e5afd098e6338c1 Mon Sep 17 00:00:00 2001 From: FreekPols Date: Mon, 20 Oct 2025 09:53:11 +0200 Subject: [PATCH 03/22] update docs on extends --- docs/creating-pdf-documents.md | 49 +++++++++++++++++++++++++++++++--- docs/frontmatter.md | 2 +- docs/table-of-contents.md | 33 +++++++++++++++++++++++ 3 files changed, 80 insertions(+), 4 deletions(-) diff --git a/docs/creating-pdf-documents.md b/docs/creating-pdf-documents.md index 0865ed2347..f63afb2a44 100644 --- a/docs/creating-pdf-documents.md +++ b/docs/creating-pdf-documents.md @@ -178,6 +178,7 @@ myst templates list arxiv_two_column --tex There are two ways to provide information to a template, through `parts` and `options`. + ## Template `parts` The `parts` of a template are things like `abstract`, `acknowledgments` or `data_availability`, see [](./document-parts.md) for more information. These parts are usually written pieces of a document, but are placed specifically in a template. For example, an abstract usually has a place in templates, with a box or other typographic choices applied. These parts can be marked as `required`, and will raise error in the PDF export process, however, myst will always try to complete the build. @@ -215,6 +216,47 @@ exports: Any unrecognized, or malformed entries will be logged as errors as well as required options that are not provided. + +### Setting options using extends +Using [extends](#composing-myst-yml) you can create an `export.yml` file which is referred to in the `myst.yml` file: + +```{code-block} yaml +:filename: myst.yml +--- +extends: + - export.yml +--- +``` + +in which you set these parts and options: + +```{code-block} yaml +:filename: export.yml +--- +version: 1 +project: + + downloads: + - id: output-pdf1 + + exports: + - id: output-pdf1 + format: typst + template: https://github.com/myst-templates/plain_typst_book + output: book.pdf + # additional options + + #### Cover picture + cover: Cover.PNG + #Coverposition: + # coverwidth: + + #### Logo at top of position + logo: logo.svg + logo_width: 10 +--- +``` + ## Creating a Template The export list can also point to local templates, for $\LaTeX$ these are built using [`jtex`](/jtex), and you can learn more about how to create a template for: [any $\LaTeX$ document](/jtex/create-a-latex-template) and [Beamer presentations](/jtex/create-a-beamer-template). @@ -241,11 +283,11 @@ Please consider [contributing your template](/jtex/contribute-a-template) to the If you have a [block](./blocks.md) or notebook cell that you do not want to render to your $\LaTeX$ output, add the `no-tex` tag to the cell. Similarly, to exclude a cell from Typst, use `no-typst`. To exclude a cell from both formats, use `no-pdf`. -```markdown -+++{no-pdf} +````markdown ++++{"no-pdf": true} This will not be in the pdf +++ -``` +```` ## Including Content with Specific Exports @@ -337,3 +379,4 @@ exports: title: Summary of this Thesis --- ``` + diff --git a/docs/frontmatter.md b/docs/frontmatter.md index 1d209afad0..d11040f8ca 100644 --- a/docs/frontmatter.md +++ b/docs/frontmatter.md @@ -85,7 +85,7 @@ The behavior of each frontmatter field is hard-coded within MyST. These are the ### Compose multiple `.yml` files -You may separate your frontmatter into multiple, composable files. This allows you to have a single source of truth for frontmatter to re-use across multiple projects, for example math macros or funding information. +You may separate your frontmatter into multiple, composable files (see this [example for a long ToC](#using-extend-for-a-long-toc)). This allows you to have a single source of truth for frontmatter to re-use across multiple projects, for example math macros or funding information. To reference other files from your main `myst.yml` file, use the `extends` key with relative path(s) to the other configuration files: diff --git a/docs/table-of-contents.md b/docs/table-of-contents.md index 5560fc8b45..fb990819cb 100644 --- a/docs/table-of-contents.md +++ b/docs/table-of-contents.md @@ -270,3 +270,36 @@ New users should use `myst.yml` instead. Jupyter Book v2 uses the MyST engine, but Jupyter Book v1 uses a different configuration structure that is designed for Sphinx. However, you can currently use a Jupyter Book v1 Table of Contents file (`_toc.yml`) with MyST.The documentation for this format is fully described in [Jupyter Book](https://jupyterbook.org/en/stable/structure/toc.html). :::: + +## Using extend for a long ToC +In some cases the ToC becomes very long, where it would be more convenient to create a separate ToC file. This can be done using [extends](#composing-myst-yml). + +```{code-block} yaml +:filename: myst.yml +--- +version: 1 +project: + [..] + +extends: + - toc.yml + +site: + [..] +--- +``` + +```{code-block} yaml +:filename: toc.yml +--- +version: 1 +project: + toc: + - file: index.md + - title: Some title + children: + - file: introduction/about.md + - file: introduction/credits.md +--- +``` + From 84b18b7798f4e3606dee843995a51e6116a48511 Mon Sep 17 00:00:00 2001 From: FreekPols Date: Sat, 25 Oct 2025 20:16:10 +0200 Subject: [PATCH 04/22] abbreviations in yml file using extends --- docs/abbreviations.yml | 40 +++++++++++++++++++++++++++++++++++++++ docs/myst.yml | 43 ++++++------------------------------------ 2 files changed, 46 insertions(+), 37 deletions(-) create mode 100644 docs/abbreviations.yml diff --git a/docs/abbreviations.yml b/docs/abbreviations.yml new file mode 100644 index 0000000000..714e674b18 --- /dev/null +++ b/docs/abbreviations.yml @@ -0,0 +1,40 @@ +version: 1 +project: + + abbreviations: + # Alphabetical order + AMS: American Mathematical Society + API: Application Programming Interface + AST: Abstract Syntax Tree + CLI: Command Line Interface + CRediT: Contributor Roles Taxonomy + CSS: Cascading Style Sheet + CSV: comma-separated values + DOI: Digital Object Identifier + ESM: ECMAScript Modules + GPU: Graphics Processing Unit + HTML: Hypertext Markup Language + ID: Identifier + ISNI: International Standard Name Identifier + JATS: Journal Article Tag Suite + JSON: JavaScript Object Notation + LTS: Long Term Support + MyST: Markedly Structured Text + NISO: National Information Standards Organization + OA: Open Access + PDF: Portable Document Format + PID: Persistent Identifier + POSIX: Portable Operating System Interface + REES: Reproducible Execution Environment Specification + ROR: Research Organization Registry + RRID: Research Resource Identifier + RST: reStructuredText + SPDX: Software Package Data Exchange + TLA: Three Letter Acronym + TOC: table of contents + TPU: Tensor Processing Unit + URL: Uniform Resource Locator + VoR: Version of Record + WASM: WebAssembly + YAML: Yet Another Markup Language + XML: Extensible Markup Language \ No newline at end of file diff --git a/docs/myst.yml b/docs/myst.yml index d8fe43fd44..151009d595 100644 --- a/docs/myst.yml +++ b/docs/myst.yml @@ -16,43 +16,7 @@ project: jtex: https://mystmd.org/jtex/ spec: https://mystmd.org/spec/ biapol: https://biapol.github.io/blog/ - abbreviations: - # Alphabetical order - AMS: American Mathematical Society - API: Application Programming Interface - AST: Abstract Syntax Tree - CLI: Command Line Interface - CRediT: Contributor Roles Taxonomy - CSS: Cascading Style Sheet - CSV: comma-separated values - DOI: Digital Object Identifier - ESM: ECMAScript Modules - GPU: Graphics Processing Unit - HTML: Hypertext Markup Language - ID: Identifier - ISNI: International Standard Name Identifier - JATS: Journal Article Tag Suite - JSON: JavaScript Object Notation - LTS: Long Term Support - MyST: Markedly Structured Text - NISO: National Information Standards Organization - OA: Open Access - PDF: Portable Document Format - PID: Persistent Identifier - POSIX: Portable Operating System Interface - REES: Reproducible Execution Environment Specification - ROR: Research Organization Registry - RRID: Research Resource Identifier - RST: reStructuredText - SPDX: Software Package Data Exchange - TLA: Three Letter Acronym - TOC: table of contents - TPU: Tensor Processing Unit - URL: Uniform Resource Locator - VoR: Version of Record - WASM: WebAssembly - YAML: Yet Another Markup Language - XML: Extensible Markup Language + plugins: - directives.mjs - picsum.mjs @@ -66,6 +30,7 @@ project: path: markup.py - type: javascript path: markup.mjs + error_rules: - rule: link-resolves severity: ignore @@ -77,6 +42,7 @@ project: - /jtex/create-a-latex-template - /jtex/create-a-beamer-template - /jtex/contribute-a-template + toc: - file: index.md - file: installing.md @@ -183,6 +149,9 @@ project: - file: contribute-add-feature.md - file: cite.md +extends: + - abbreviations.yml + site: title: MyST Markdown Guide domains: From caf157bfdb445bf342e7b24c8380868f2f94fcc3 Mon Sep 17 00:00:00 2001 From: FreekPols Date: Sat, 25 Oct 2025 20:33:52 +0200 Subject: [PATCH 05/22] small changes in admonitions for readability --- docs/admonitions.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/docs/admonitions.md b/docs/admonitions.md index e860d7df27..0a0b38f062 100644 --- a/docs/admonitions.md +++ b/docs/admonitions.md @@ -5,15 +5,12 @@ thumbnail: ./thumbnails/admonitions.png --- Callouts, or "admonitions", highlight a particular block of text that exists slightly apart from the narrative of your page, such as a note or a warning. -For example, try changing the following example of a `{tip}` admonition to a `{warning}`: -```{myst} -:::{tip} -Try changing `tip` to `warning`! -::: +```{tip} +See the different admonitions below and try it yourself in the next admonition! ``` -In MyST we call these kinds of directives {myst:directive}`admonitions `, however, they are almost always used through their _named_ directives, like {myst:directive}`note` or {myst:directive}`danger`. There are ten kinds[^docutils-admonitions] of admonitions available: +In MyST we call these kinds of directives {myst:directive}`admonitions `, however, they are almost always used through their _named_ directives, like {myst:directive}`note` or {myst:directive}`danger`. There are ten kinds[^docutils-admonitions] of admonitions available by default, and several others by the use of [plugins](./plugins.md): ```{list-table} Named admonitions that can be used as directives :label: admonitions-list @@ -31,6 +28,16 @@ In MyST we call these kinds of directives {myst:directive}`admonitions Date: Sat, 25 Oct 2025 20:35:51 +0200 Subject: [PATCH 06/22] small change in analytics for readability --- docs/analytics.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/analytics.md b/docs/analytics.md index 2d5391be68..67edba5ebf 100644 --- a/docs/analytics.md +++ b/docs/analytics.md @@ -5,7 +5,8 @@ description: Add Google Analytics or Plausible to your MyST website with a site thumbnail: ./thumbnails/analytics.png --- -There are no tracking cookies or analytics added to a MyST site by default, however, you may want to know more about basic analytics for your domain when you deploy it. There are two analytics tracking codes that MyST site templates currently supports: +There are no tracking cookies or analytics added to a MyST site by default. +However, there are two analytics tracking codes that MyST site templates currently supports: 1. [Google Analytics](https://marketingplatform.google.com/about/analytics/); and 2. [Plausible](https://plausible.io/), which is privacy-friendly alternative to Google. From 4dd565cb548c5b707206dd10abeff77f6a16dd07 Mon Sep 17 00:00:00 2001 From: FreekPols Date: Sat, 25 Oct 2025 20:40:24 +0200 Subject: [PATCH 07/22] changed markdown example in aside to better understand the aside --- docs/asides.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/asides.md b/docs/asides.md index 12f4cd10fe..b36fd1cb20 100644 --- a/docs/asides.md +++ b/docs/asides.md @@ -4,7 +4,8 @@ short_title: Asides & Margins description: Asides provide an easy way to represent content that is only indirectly related to the article's main content, such as in the sidebar or margin. --- -Asides provide an easy way to represent content that is only indirectly related to the article's main content. Where supported, MyST will attempt to display an {myst:directive}`aside` _as close as possible_ but separately from the main article, such as in the side-margin. +Asides provide an easy way to represent content that is only indirectly related to the article's main content. +Where supported, MyST will attempt to display an {myst:directive}`aside` _as close as possible_ but separately from the main article, such as in the side-margin. ```{aside} Margin Content Here’s some margin content! It was created by using the {myst:directive}`margin` directive in a Markdown, we can include images: @@ -15,8 +16,12 @@ or any other sort of content! ``` ```markdown -:::{aside} An Optional Title -This is an aside. It is not entirely relevant to the main article. +:::{aside} Margin Content +Here’s some margin content! It was created by using the {myst:directive}`margin` directive in a Markdown, we can include images: + +![](https://github.com/rowanc1/pics/blob/main/sunset.png) + +or any other sort of content! ::: ``` @@ -28,6 +33,7 @@ Many of the features on this page are experimental and may change at any time. These elements can conflict with the document outline when they are both competing for the margin space (see [#170](https://github.com/jupyter-book/myst-theme/issues/170)). +There is, yet, no plugin available transforming this directive into a Typst pdf. ::: % Using bold here, until we fix #170 From ac4f2ab2e0917fc233a008522f4a8f4d669511db Mon Sep 17 00:00:00 2001 From: FreekPols Date: Sat, 25 Oct 2025 20:46:16 +0200 Subject: [PATCH 08/22] small edits in authorship for readability --- docs/authorship.md | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/docs/authorship.md b/docs/authorship.md index dab678814c..bc8b205fcf 100644 --- a/docs/authorship.md +++ b/docs/authorship.md @@ -1,10 +1,12 @@ # Authorship and attribution -You can bundle information about the authors of each page in a MyST project, as well as metadata about them. For example, their institutional affiliations, funding, etc. +You can bundle information about the authors of each page in a MyST project, as well as metadata about them. +For example, their institutional affiliations, funding, etc. ## How to set author information -Author information is set with [MyST frontmatter](./frontmatter.md). You can set this either in **`myst.yml`** (in which case, they will apply to all documents in a MyST project), or in the **page frontmatter** (in which case they'll just apply to that page). +Author information is set with [MyST frontmatter](./frontmatter.md). +You can set this either in **`myst.yml`** (in which case, they will apply to all documents in a MyST project), or in the **page frontmatter** (in which case they'll just apply to that page). For example, the examples below show frontmatter for authors and [author affiliations](#affiliations) in frontmatter of an `article.md` file, and in `myst.yml`: @@ -51,7 +53,8 @@ See [the `authors` frontmatter reference](#frontmatter:authors) for a list of al ### Re-use author information across repositories and projects -By [extending MyST configuration files](#composing-myst-yml) you can store author information in one place and re-use it across many other locations. This allows you to define a source of truth for authorship and affiliations, and reference that over time. For example: +By [extending MyST configuration files](#composing-myst-yml) you can store author information in one place and re-use it across many other locations. +This allows you to define a source of truth for authorship and affiliations, and reference that over time. For example: In one file, you'd define all the author affiliations that are relevant to your project: @@ -88,7 +91,7 @@ And in each of your project `myst.yml` files, you can extend this authorship fil :filename: myst.yml version: 1 extends: - - ./authors.yml # OR, the URL of this file if not hosted locally + - ./authors.yml # Or, the URL of this file if not hosted locally project: authors: - person_a @@ -108,10 +111,10 @@ Page content... ``` (affiliations)= - ## Affiliations -You can create an affiliation directly by adding it to an author. It can be as simple as a single string. +You can create an affiliation directly by adding it to an author. +It can be as simple as a single string. ```yaml authors: @@ -119,7 +122,8 @@ authors: affiliation: University of British Columbia ``` -You can also add much more information to any affiliation, such as a ROR, ISNI, or an address. A very complete affiliations list for an author at the University of British Columbia is: +You can also add much more information to any affiliation, such as a ROR, ISNI, or an address. +A very complete affiliations list for an author at the University of British Columbia is: ```yaml authors: @@ -141,7 +145,8 @@ authors: affiliation: ubc ``` -Notice how you can use an `id` to avoid writing this out for every coauthor. Additionally, if the affiliation is a single string and contains a semi-colon `;` it will be treated as a list. +Notice how you can use an `id` to avoid writing this out for every coauthor. +Additionally, if the affiliation is a single string and contains a semi-colon `;` it will be treated as a list. If you use a string that is not recognized as an already defined affiliation in the project or article frontmatter, an affiliation will be created automatically and normalized so that it can be referenced: @@ -192,7 +197,8 @@ To do so, use the following fields in an entry for either `author` or the `affil ![](#table-frontmatter-social-links) (other-contributors)= - ## Reviewers, Editors, Funding Recipients -Other contributors besides authors may be listed elsewhere in the frontmatter. These include `reviewers`, `editors`, and [funding](#frontmatter:funding) award `investigators` and `recipients`. For all of these fields, you may use a full [author object](#frontmatter:authors), or you may use the string `id` from an existing author object defined elsewhere in your frontmatter. +Other contributors besides authors may be listed elsewhere in the frontmatter. +These include `reviewers`, `editors`, and [funding](#frontmatter:funding) award `investigators` and `recipients`. +For all of these fields, you may use a full [author object](#frontmatter:authors), or you may use the string `id` from an existing author object defined elsewhere in your frontmatter. From 7bc2b0f47baebca3768588ea3f3a6397683d7c3f Mon Sep 17 00:00:00 2001 From: FreekPols Date: Sat, 25 Oct 2025 20:56:39 +0200 Subject: [PATCH 09/22] update citations, didnt work to get a link to citations#reference at the finger pointing down --- docs/citations.md | 35 +++++++++++++++++++++++++---------- 1 file changed, 25 insertions(+), 10 deletions(-) diff --git a/docs/citations.md b/docs/citations.md index 17e5a2473d..4bc8cbcb6f 100644 --- a/docs/citations.md +++ b/docs/citations.md @@ -5,13 +5,17 @@ description: Add academic citations to your documents easily, have hover-referen thumbnail: ./thumbnails/citations.png --- -Citations automatically show up in your site, including a references section at the bottom of the page. These citations are able to be clicked on to see more information, like the abstract. There are two different ways to add citations to your documents: (1) adding a Markdown link to a [DOI](wiki:Digital_object_identifier); and (2) by adding a BibTeX file, which can be exported from any reference manager, and adding a `cite` role to your content. +Citations automatically show up in your site, including a references section at the bottom of the page. +These citations are able to be clicked on to see more information, like the abstract. +There are two different ways to add citations to your documents: +1. adding a Markdown link to a [DOI](wiki:Digital_object_identifier); and +2. by adding a BibTeX file, which can be exported from any reference manager, and adding a `cite` role to your content. (doi-links)= - ## Simple Referencing with a DOI Link -Link to any DOI in your Markdown files or Jupyter Notebooks by including a link to the DOI. Provided the `DOI` is formatted correctly, this will be transformed during the build process to a citation with a pop-up panel on hover like this: [Cockett, 2022](https://doi.org/10.5281/zenodo.6476040), and the reference information will be automatically added to the reference section at the bottom of your notebook (see below👇). +Link to any DOI in your Markdown files or Jupyter Notebooks by including a link to the DOI. +Provided the `DOI` is formatted correctly, this will be transformed during the build process to a citation with a pop-up panel on hover like this: [Cockett, 2022](https://doi.org/10.5281/zenodo.6476040), and the reference information will be automatically added to the reference section at the bottom of your notebook (see below 👇). ```md This is a link in Markdown: [Cockett, 2022](https://doi.org/10.5281/zenodo.6476040). @@ -19,9 +23,13 @@ This is a link in Markdown: [Cockett, 2022](https://doi.org/10.5281/zenodo.64760 It is also possible to drop the link text, that is:\ `` or `[](doi:10.5281/zenodo.6476040)`,\ -which will insert the citation text in the correct format (e.g. adding an italic "_et al._", etc.). If the DOI is present on a citation from a BibTeX file in your project, that citation will be used. Otherwise, the citation data for these DOIs will be downloaded from `https://doi.org` once and cached to a local file in the `_build` directory. This cache may be cleared with `myst clean --cache`. +which will insert the citation text in the correct format (e.g. adding an italic "_et al._", etc.). +If the DOI is present on a citation from a BibTeX file in your project, that citation will be used. +Otherwise, the citation data for these DOIs will be downloaded from `https://doi.org` once and cached to a local file in the `_build` directory. +This cache may be cleared with `myst clean --cache`. -Providing your DOIs as full links has the advantage that on other rendering platforms (e.g. GitHub), your citation will still be shown as a link. If you have many citations, however, this will slow down the build process as the citation information is fetched dynamically. +Providing your DOIs as full links has the advantage that on other rendering platforms (e.g. GitHub), your citation will still be shown as a link. +If you have many citations, however, this will slow down the build process as the citation information is fetched dynamically. :::{note} Dealing with complex DOIs :class: dropdown @@ -41,19 +49,21 @@ For DOIs with multiple slashes in the identifier you also have to use the full h ### Writing DOIs to BibTeX -If you encounter problems fetching DOIs from `https://doi.org`, for example the downloaded citation does not include all the data you expect or requests to `https://doi.org` are failing on an automated continuous integration platform, you may write your DOI citations to file using the MyST command +If you encounter problems fetching DOIs from `https://doi.org`, for example the downloaded citation does not include all the data you expect or requests to `https://doi.org` are failing on an automated continuous integration platform, you may write your DOI citations to file using the MyST command: ```bash myst build --doi-bib ``` -This will generate a BibTeX file `myst.doi.bib` which you may then rename, edit, and save to your project. On subsequent builds, the DOIs will be loaded from this file rather than fetched remotely. +This will generate a BibTeX file `myst.doi.bib` which you may then rename, edit, and save to your project. +On subsequent builds, the DOIs will be loaded from this file rather than fetched remotely. ## Including BibTeX A standard way of including references for $\LaTeX$ is using , you can include a `*.bib` file or files in the same directory as your content directory for the project. These will provide the reference keys for that project. -If you want to explicitly reference which BibTeX files to use, as well as what order to resolve them in, you can use the `bibliography` field in your frontmatter, which is a string array of local or remote files. This will load the files in order specified. +If you want to explicitly reference which BibTeX files to use, as well as what order to resolve them in, you can use the `bibliography` field in your frontmatter, which is a string array of local or remote files. +This will load the files in order specified. ```yaml bibliography: @@ -66,7 +76,11 @@ The remote BibTeX can be helpful for working with reference managers that suppor ## Markdown Citations You can add citations to any BibTeX entry using the citation key preceded by an `@`, for example, `@author2023`. -This syntax follows the [pandoc citation syntax](https://pandoc.org/MANUAL.html#citation-syntax). Multiple citations can be grouped together with square brackets, separated with semi-colons. It is also possible to add a prefix or suffix to parenthetical citations, for example, `[e.g. @author2023, chap. 3; @author1995]`. To add a suffix to a narrative citation, follow the citation with the suffix in square brackets, for example, `@author2023 [chap. 3]`. As with a link to a DOI, you can also use the DOI directly instead of the BibTeX key. +This syntax follows the [pandoc citation syntax](https://pandoc.org/MANUAL.html#citation-syntax). +Multiple citations can be grouped together with square brackets, separated with semi-colons. +It is also possible to add a prefix or suffix to parenthetical citations, for example, `[e.g. @author2023, chap. 3; @author1995]`. +To add a suffix to a narrative citation, follow the citation with the suffix in square brackets, for example, `@author2023 [chap. 3]`. +As with a link to a DOI, you can also use the DOI directly instead of the BibTeX key. ```{list-table} Examples of Markdown citations :header-rows: 1 @@ -99,7 +113,8 @@ This syntax follows the [pandoc citation syntax](https://pandoc.org/MANUAL.html# ## Citation Roles -MyST also provides a number of roles for compatibility with Sphinx and Jupyter Book V1. To create a citation role in Markdown, use either a parenthetical or textual citation: +MyST also provides a number of roles for compatibility with Sphinx and Jupyter Book V1. +To create a citation role in Markdown, use either a parenthetical or textual citation: ```md This is a parenthetical citation {cite:p}`cockett2015`. From 530c0b46211dd68438e8be1f6096a3b0c8c8eb27 Mon Sep 17 00:00:00 2001 From: Freek Pols <55780866+FreekPols@users.noreply.github.com> Date: Tue, 28 Oct 2025 07:41:04 +0100 Subject: [PATCH 10/22] Update docs/table-of-contents.md Co-authored-by: Chris Holdgraf --- docs/table-of-contents.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/table-of-contents.md b/docs/table-of-contents.md index fb990819cb..3f5b68bc1a 100644 --- a/docs/table-of-contents.md +++ b/docs/table-of-contents.md @@ -271,7 +271,7 @@ New users should use `myst.yml` instead. Jupyter Book v2 uses the MyST engine, but Jupyter Book v1 uses a different configuration structure that is designed for Sphinx. However, you can currently use a Jupyter Book v1 Table of Contents file (`_toc.yml`) with MyST.The documentation for this format is fully described in [Jupyter Book](https://jupyterbook.org/en/stable/structure/toc.html). :::: -## Using extend for a long ToC +## Configure your Table of Contents in a separate file using `extend:` In some cases the ToC becomes very long, where it would be more convenient to create a separate ToC file. This can be done using [extends](#composing-myst-yml). ```{code-block} yaml From 151a839c98c066499955b2f02130170fecd6aaba Mon Sep 17 00:00:00 2001 From: Freek Pols <55780866+FreekPols@users.noreply.github.com> Date: Tue, 28 Oct 2025 07:41:26 +0100 Subject: [PATCH 11/22] Update docs/table-of-contents.md Co-authored-by: Chris Holdgraf --- docs/table-of-contents.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/table-of-contents.md b/docs/table-of-contents.md index 3f5b68bc1a..10a7255470 100644 --- a/docs/table-of-contents.md +++ b/docs/table-of-contents.md @@ -272,7 +272,7 @@ Jupyter Book v2 uses the MyST engine, but Jupyter Book v1 uses a different confi :::: ## Configure your Table of Contents in a separate file using `extend:` -In some cases the ToC becomes very long, where it would be more convenient to create a separate ToC file. This can be done using [extends](#composing-myst-yml). +If your Table of Contents is very long, it can make your `myst.yml` difficult to read and maintain. You can use [`extends:` functionality](#composing-myst-yml) to store the ToC structure in a separate file, allowing you to re-use it in a modular way. ```{code-block} yaml :filename: myst.yml From 60e11ace58c1c6967b1339dff1dfe93487b5923e Mon Sep 17 00:00:00 2001 From: Freek Pols <55780866+FreekPols@users.noreply.github.com> Date: Tue, 28 Oct 2025 11:54:00 +0100 Subject: [PATCH 12/22] Downgrade version from 1.6.0 to 1.5.17 --- packages/myst-directives/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/myst-directives/package.json b/packages/myst-directives/package.json index 1922353590..14637a8244 100644 --- a/packages/myst-directives/package.json +++ b/packages/myst-directives/package.json @@ -1,6 +1,6 @@ { "name": "myst-directives", - "version": "1.6.0", + "version": "1.5.17", "sideEffects": false, "license": "MIT", "description": "Default directive definitions for MyST", From 2c174f933c2bdb6a18ff3a99503d00b5622b7ac8 Mon Sep 17 00:00:00 2001 From: Freek Pols <55780866+FreekPols@users.noreply.github.com> Date: Tue, 28 Oct 2025 11:56:48 +0100 Subject: [PATCH 13/22] Downgrade version from 1.0.13 to 1.0.12 Revert version number to 1.0.12. --- packages/markdown-it-myst/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/markdown-it-myst/package.json b/packages/markdown-it-myst/package.json index 0e6f29ea0c..24d385472d 100644 --- a/packages/markdown-it-myst/package.json +++ b/packages/markdown-it-myst/package.json @@ -1,6 +1,6 @@ { "name": "markdown-it-myst", - "version": "1.0.13", + "version": "1.0.12", "sideEffects": false, "license": "MIT", "description": "markdown-it tokenizer for MyST roles and directives", From 8102b06fefc7a6847dd8cfbec2ad4dcbad49342b Mon Sep 17 00:00:00 2001 From: FreekPols Date: Tue, 28 Oct 2025 18:27:12 +0100 Subject: [PATCH 14/22] small edits on figures --- docs/figures.md | 42 ++++++++++++++++++++++++++++-------------- 1 file changed, 28 insertions(+), 14 deletions(-) diff --git a/docs/figures.md b/docs/figures.md index cbdf3298cf..c43eafaadd 100644 --- a/docs/figures.md +++ b/docs/figures.md @@ -9,7 +9,7 @@ MyST Markdown can be used to include images and figures in your documents as wel ## Simple images -The simplest way to create an image is to use the standard Markdown syntax: +The simplest way to include an image is to use the standard Markdown syntax: ```md ![alt](link 'title') @@ -17,12 +17,14 @@ The simplest way to create an image is to use the standard Markdown syntax: You can explore a [demo of images](#md:image) in the discussion of [](./commonmark.md) features of MyST. -Using standard markdown to create an image will render across all output formats (HTML, TeX, Word, PDF, etc). However, this markdown syntax is limited in the configuration that can be applied beyond `alt` text and an optional `title`. +Using standard markdown to create an image will render across all output formats (HTML, TeX, Word, PDF, etc). +However, this markdown syntax is limited in the configuration that can be applied beyond `alt` text and an optional `title`. -There are two directives that can be used to add additional information about the layout and metadata associated with an image. For example, {myst:directive}`image.width`, {myst:directive}`alignment ` or a {myst:directive}`figure caption `. +There are two directives that can be used to add additional information about the layout and metadata associated with an image. +For example, {myst:directive}`image.width`, {myst:directive}`alignment ` or a {myst:directive}`figure caption `. **image** -: The {myst:directive}`image` directive allows you to customize {myst:directive}`image.width`, {myst:directive}`alignment `, and other {myst:directive}`classes ` to add to the image +: The {myst:directive}`image` directive allows you to customize {myst:directive}`image.width`, {myst:directive}`alignment `, and other {myst:directive}`classes ` to add to the image. **figure** : The {myst:directive}`figure` directive can contain a {myst:directive}`figure caption ` and allows you to cross-reference this in other parts of your document. @@ -72,7 +74,9 @@ These will be numbered as `Figure 1a` and `Figure 1b`, etc. For example: We saw some great things on our trips this year to Banff, Canada 🇨🇦 and San Francisco, USA 🌉. ::: -You can also cross-reference either the whole figure [@subFigure], or an individual subfigure [@subFigure-a] or [@subFigure-b]. Each subfigure is given an implicit reference that matches the figure label with a suffix of their letter, for example, a figure with label `my-figure` the two subfigures can be referred to as `my-figure-a` and `my-figure-b`, respectively. If you provide a [specific label for a subfigure](#label-anything), that label will be used instead of the implicit label. +You can also cross-reference either the whole figure [@subFigure], or an individual subfigure [@subFigure-a] or [@subFigure-b]. +Each subfigure is given an implicit reference that matches the figure label with a suffix of their letter, for example, a figure with label `my-figure` the two subfigures can be referred to as `my-figure-a` and `my-figure-b`, respectively. +If you provide a [specific label for a subfigure](#label-anything), that label will be used instead of the implicit label. ```{myst} :::{figure} @@ -90,12 +94,15 @@ Some pictures of fruit and the ocean! See [](#my-figure-fruit) for the fruit, and [](#my-figure) to reference both subfigures. ``` -By default, when referring to subfigures, the `{number}` that is used includes the parent enumerator (that is: `1a` rather than just `a`). To specifically use the sub-enumerator only, you can use the syntax `{subEnumerator}` in your text link which will be replaced with the sub-enumerator (that is: `a` rather than `1a`). +When referring to subfigures, the `{number}` that is used includes the parent enumerator by default (that is: `1a` rather than just `a`). +To specifically use the sub-enumerator only, you can use the syntax `{subEnumerator}` in your text link which will be replaced with the sub-enumerator (that is: `a` rather than `1a`). ## Supported Image Formats MyST supports many images formats including `.png`, `.jpg`, `.gif`, `.tiff`, `.svg`, `.pdf`, and `.eps`. -Many of these image formats are easily supported for HTML themes including `.png`, `.jpg` and `.gif`. However, the raster image formats can be further optimized to [improve site performance](./accessibility-and-performance.md), MyST translates these to the modern `.webp` format while the site is building. The original file-format is also included your site, with a `srcset` and fallback for older web-browsers. +Many of these image formats are easily supported for HTML themes including `.png`, `.jpg` and `.gif`. +However, the raster image formats can be further optimized to [improve site performance](./accessibility-and-performance.md), MyST translates these to the modern `.webp` format while the site is building. +The original file-format is also included your site, with a `srcset` and fallback for older web-browsers. `````{tab-set} ````{tab-item} PNG @@ -150,7 +157,10 @@ An `.eps` image is not supported by web-browsers or Microsoft Word. The images a ### Image Transformers -There are formats that are not supported by web-browsers but are common in scientific writing like `.tiff`, `.pdf` and `.eps` for site builds, these are converted to `.svg` or `.png` as appropriate and available. For export to $\LaTeX$, PDF or Microsoft Word, the files are converted to an appropriate format that the export can handle (e.g. $\LaTeX$ can work directly with `.pdf` images). For animated images, `.gif`, the first frame is extracted for static exports. +There are formats that are not supported by web-browsers but are common in scientific writing like `.tiff`, `.pdf` and `.eps`. +For site builds, these are converted to `.svg` or `.png` as appropriate and available. +For export to $\LaTeX$, PDF or Microsoft Word, the files are converted to an appropriate format that the export can handle (e.g. $\LaTeX$ can work directly with `.pdf` images). +For animated images, `.gif`, the first frame is extracted for static exports. :::{tip} Installing Image Converters :class: dropdown @@ -166,13 +176,15 @@ The image transforms and optimizations requires you to have the following packag ### Multiple Images -If you have manually converted your images or have different images for different formats, use an asterisk (`*`) as the extension. All images matching the provided pattern will be found and the best image out of the available candidates will be used for the export: +If you have manually converted your images or have different images for different formats, use an asterisk (`*`) as the extension. +All images matching the provided pattern will be found and the best image available will be used for the export: ```text ![](./images/myst-image.*) ``` -For example, when exporting to $\LaTeX$ the best format is a `.pdf` if it is available; in a web export, a `.webp` or `.svg` will be chosen before a `.png`. In all cases, if an appropriate format is not available the image will be translated. +For example, when exporting to $\LaTeX$ the best format is a `.pdf` (if available); in a web export, a `.webp` or `.svg` will be chosen before a `.png`. +In all cases, if an appropriate format is not available the image will be converted. ## Videos @@ -182,9 +194,9 @@ To embed a video you can either use a video platforms embed script or directly e :::{figure} ./videos/links.mp4 An embedded video with a caption! ::: - +``` or - +```markdown ![](./videos/links.mp4) ``` @@ -194,7 +206,8 @@ will copy the video to your static files and embed a video in your HTML output. An embedded video with a caption! ::: -If you have [ffmpeg](https://www.ffmpeg.org/) installed, you may also include `.mov` and `.avi` video files, and MyST will convert them to `.mp4` and include them. Videos can also be used in the [image](#image-directive) or even in simple [Markdown image](#md:image). +If you have [ffmpeg](https://www.ffmpeg.org/) installed, you may also include `.mov` and `.avi` video files, and MyST will convert them to `.mp4` and include them. +Videos can also be used in the [image](#image-directive) or even in simple [Markdown image](#md:image). ### Use an image in place of a video for static exports @@ -226,7 +239,8 @@ Get up and running with MyST in Jupyter! ::: ``` -You can find this URL when clicking share > embed on various platforms. You can also give the {myst:directive}`iframe` directive {myst:directive}`iframe.width` and a {myst:directive}`caption `. +You can find this URL when clicking share -> embed on various platforms. +You can also give the {myst:directive}`iframe` directive {myst:directive}`iframe.width` and a {myst:directive}`caption `. ## Provide Light and Dark Mode images From 272c76ef6e339a32101e04c5bfd4abec693ac099 Mon Sep 17 00:00:00 2001 From: FreekPols Date: Tue, 28 Oct 2025 18:32:12 +0100 Subject: [PATCH 15/22] included notification of plugin for pdf export --- docs/exercises.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/docs/exercises.md b/docs/exercises.md index 4a5b85cb34..f96e9b42e5 100644 --- a/docs/exercises.md +++ b/docs/exercises.md @@ -5,7 +5,8 @@ description: MyST supports adding exercises and solutions which can cross-refere thumbnail: ./thumbnails/exercise.png --- -There are two directives available to add exercises and solutions to your documents: (1) an `exercise` directive; and (2) a `solution` directive. The exercises are enumerated by default and can take in an optional title argument as well as be "gated" around Jupyter Notebook cells. +There are two directives available to add exercises and solutions to your documents: (1) an `exercise` directive; and (2) a `solution` directive. +The exercises are enumerated by default and can take in an optional title argument as well as be "gated" around Jupyter Notebook cells. ## Exercise Directive @@ -55,7 +56,10 @@ The following options for exercise directives are supported: ## Solution Directive -A solution directive can be included using the `solution` pattern. It takes in the label of the directive it wants to link to as a required argument. Unlike the `exercise` directive, the solution directive is not enumerable as it inherits numbering directly from the linked exercise. The argument for a solution is the label of the linked exercise, which is required. +A solution directive can be included using the `solution` pattern. +It takes in the label of the directive it wants to link to as a required argument. +Unlike the `exercise` directive, the solution directive is not enumerable as it inherits numbering directly from the linked exercise. +The argument for a solution is the label of the linked exercise, which is required. ::::{tab-set} :::{tab-item} Example @@ -138,7 +142,8 @@ For example,\ ### Referencing Solutions -You can refer to a solution directly as well using a Markdown link or using the {myst:role}`ref` role like: `` {ref}`my-solution` `` the output of which depends on the attributes of the linked directive. If the linked directive is enumerable, the role will replace the solution reference with the linked directive type and its appropriate number like so: {ref}`my-solution`. +You can refer to a solution directly as well using a Markdown link or using the {myst:role}`ref` role like: `` {ref}`my-solution` `` the output of which depends on the attributes of the linked directive. +If the linked directive is enumerable, the role will replace the solution reference with the linked directive type and its appropriate number like so: {ref}`my-solution`. In the event that the directive being referenced is unenumerable, the reference will display its title: {ref}`nfactorial-solution`. @@ -204,7 +209,8 @@ static int factorial(int n){ ## Alternative Gated Syntax -To be able to be viewed as Jupyter Notebooks (e.g. in [JupyterLab MyST](./quickstart-jupyter-lab-myst.md)) `code-cell` directives must be at the root level of the document for them to be executed. This maintains direct compatibility with the `jupyter notebook` and enables tools like `jupytext` to convert between `myst` and `ipynb` files. +To be able to be viewed as Jupyter Notebooks (e.g. in [JupyterLab MyST](./quickstart-jupyter-lab-myst.md)) `code-cell` directives must be at the root level of the document for them to be executed. +This maintains direct compatibility with the `jupyter notebook` and enables tools like `jupytext` to convert between `myst` and `ipynb` files. As a result **executable** `code-cell` directives cannot be nested inside of exercises or solution directives. @@ -264,7 +270,8 @@ and maybe you wish to add a figure ::: :::: -This can also be completed for solutions with `solution-start` and `solution-end` directives. The `solution-start` and `exercise-start` directives have the same options as original directive. +This can also be completed for solutions with `solution-start` and `solution-end` directives. +The `solution-start` and `exercise-start` directives have the same options as original directive. ```{warning} Mismatched Start & End :class: dropdown @@ -326,5 +333,11 @@ This is a hidden exercise directive. ``` ```` +## Exporting exercises and solutions + +When exporting content which include exercises and solutions to pdf using either LaTeX or Typst, warning errors are raised since these directives are not natively supported in these formats. +A plugin is [available](https://github.com/jupyter-book/myst-plugins/tree/main/plugins/exercise-admonition-pdf) to enable exporting these directives to pdf formats - including numeration. + + % TODO: Remove All Solutions % TODO: Custom CSS From 4505aeabc18b4495325c24033269e79bb34f2ebf Mon Sep 17 00:00:00 2001 From: Freek Pols <55780866+FreekPols@users.noreply.github.com> Date: Tue, 28 Oct 2025 19:12:02 +0100 Subject: [PATCH 16/22] Update docs/admonitions.md Co-authored-by: Stefan van der Walt --- docs/admonitions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/admonitions.md b/docs/admonitions.md index 0a0b38f062..1efca1186d 100644 --- a/docs/admonitions.md +++ b/docs/admonitions.md @@ -10,7 +10,7 @@ Callouts, or "admonitions", highlight a particular block of text that exists sli See the different admonitions below and try it yourself in the next admonition! ``` -In MyST we call these kinds of directives {myst:directive}`admonitions `, however, they are almost always used through their _named_ directives, like {myst:directive}`note` or {myst:directive}`danger`. There are ten kinds[^docutils-admonitions] of admonitions available by default, and several others by the use of [plugins](./plugins.md): +In MyST we call these kinds of directives {myst:directive}`admonitions `, however, they are almost always used through their _named_ directives, like {myst:directive}`note` or {myst:directive}`danger`. There are ten kinds[^docutils-admonitions] of admonitions available by default, and others may be introduced by [plugins](./plugins.md): ```{list-table} Named admonitions that can be used as directives :label: admonitions-list From b68ead7054ce3a2d56df6f859b43b8b93972187e Mon Sep 17 00:00:00 2001 From: Freek Pols <55780866+FreekPols@users.noreply.github.com> Date: Tue, 28 Oct 2025 19:53:17 +0100 Subject: [PATCH 17/22] Update docs/admonitions.md Co-authored-by: Stefan van der Walt --- docs/admonitions.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/admonitions.md b/docs/admonitions.md index 1efca1186d..4730374fcf 100644 --- a/docs/admonitions.md +++ b/docs/admonitions.md @@ -36,8 +36,6 @@ Try changing `tip` to `warning`! ::: ``` - - See below for a demo of each admonition in the default theme. `````{tab-set} From 2b2ff6d687991be540f4780de88889b76ec92dc2 Mon Sep 17 00:00:00 2001 From: Freek Pols <55780866+FreekPols@users.noreply.github.com> Date: Tue, 28 Oct 2025 19:57:34 +0100 Subject: [PATCH 18/22] Update docs/asides.md Co-authored-by: Stefan van der Walt --- docs/asides.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/asides.md b/docs/asides.md index b36fd1cb20..726abaa3a3 100644 --- a/docs/asides.md +++ b/docs/asides.md @@ -5,7 +5,7 @@ description: Asides provide an easy way to represent content that is only indire --- Asides provide an easy way to represent content that is only indirectly related to the article's main content. -Where supported, MyST will attempt to display an {myst:directive}`aside` _as close as possible_ but separately from the main article, such as in the side-margin. +Where supported, MyST will attempt to display an {myst:directive}`aside` _as close as possible to_—but separate from—the main article, such as in the side-margin. ```{aside} Margin Content Here’s some margin content! It was created by using the {myst:directive}`margin` directive in a Markdown, we can include images: From f696cb66b405d16d37688eca751d291d7c70e2a3 Mon Sep 17 00:00:00 2001 From: Freek Pols <55780866+FreekPols@users.noreply.github.com> Date: Tue, 28 Oct 2025 19:57:52 +0100 Subject: [PATCH 19/22] Update docs/authorship.md Co-authored-by: Stefan van der Walt --- docs/authorship.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/authorship.md b/docs/authorship.md index bc8b205fcf..58da080552 100644 --- a/docs/authorship.md +++ b/docs/authorship.md @@ -1,7 +1,6 @@ # Authorship and attribution -You can bundle information about the authors of each page in a MyST project, as well as metadata about them. -For example, their institutional affiliations, funding, etc. +A MyST project can include metadata about the authors of each page, such as institutional affiliations, funding sources, etc. ## How to set author information From a2b952b426509fbe4e40c8384bb78a38c1b41643 Mon Sep 17 00:00:00 2001 From: FreekPols Date: Tue, 28 Oct 2025 20:24:35 +0100 Subject: [PATCH 20/22] processing suggestions --- docs/admonitions.md | 7 ++----- docs/analytics.md | 4 ++-- docs/asides.md | 2 +- docs/authorship.md | 4 ++-- 4 files changed, 7 insertions(+), 10 deletions(-) diff --git a/docs/admonitions.md b/docs/admonitions.md index 4730374fcf..b9d1984fce 100644 --- a/docs/admonitions.md +++ b/docs/admonitions.md @@ -6,9 +6,6 @@ thumbnail: ./thumbnails/admonitions.png Callouts, or "admonitions", highlight a particular block of text that exists slightly apart from the narrative of your page, such as a note or a warning. -```{tip} -See the different admonitions below and try it yourself in the next admonition! -``` In MyST we call these kinds of directives {myst:directive}`admonitions `, however, they are almost always used through their _named_ directives, like {myst:directive}`note` or {myst:directive}`danger`. There are ten kinds[^docutils-admonitions] of admonitions available by default, and others may be introduced by [plugins](./plugins.md): @@ -139,7 +136,7 @@ GitHub Markdown transforms blockquotes that start with a bold `Note` or text wit ::::{tip} Compatibility with Pandoc & Quarto :class: dropdown -In Quarto/Pandoc Markdown admonitions are styled with special classes (e.g. `{.callout-note}` or `{.callout-tip}`). +In Quarto/Pandoc Markdown admonitions are styled with special classes (like `{.callout-note}` or `{.callout-tip}`). If you are using Jupyter Book V1 or Sphinx documentation, use an {myst:directive}`admonition` directive with the specific class, for example: ```{myst} @@ -153,7 +150,7 @@ This is an example of a callout with a caption. ::::{warning} Compatibility with Sphinx :class: dropdown -In Sphinx, all named admonitions (e.g. `{note}` or `{tip}`), have **no arguments**. +In Sphinx, all named admonitions (like `{note}` or `{tip}`), have **no arguments**. If you place content on the first line it will instead be prepended to the admonition body. If you are using Jupyter Book V1 or Sphinx documentation, use an {myst:directive}`admonition` directive with the specific class, for example: diff --git a/docs/analytics.md b/docs/analytics.md index 67edba5ebf..ce33108c77 100644 --- a/docs/analytics.md +++ b/docs/analytics.md @@ -5,8 +5,8 @@ description: Add Google Analytics or Plausible to your MyST website with a site thumbnail: ./thumbnails/analytics.png --- -There are no tracking cookies or analytics added to a MyST site by default. -However, there are two analytics tracking codes that MyST site templates currently supports: +By default, MyST sites contain no tracking cookies or analytics. +However, we offer support for two analytics tracking systems: 1. [Google Analytics](https://marketingplatform.google.com/about/analytics/); and 2. [Plausible](https://plausible.io/), which is privacy-friendly alternative to Google. diff --git a/docs/asides.md b/docs/asides.md index 726abaa3a3..b993bcc246 100644 --- a/docs/asides.md +++ b/docs/asides.md @@ -33,7 +33,7 @@ Many of the features on this page are experimental and may change at any time. These elements can conflict with the document outline when they are both competing for the margin space (see [#170](https://github.com/jupyter-book/myst-theme/issues/170)). -There is, yet, no plugin available transforming this directive into a Typst pdf. +There is, as yet, no plugin available for transforming this directive into Typst. ::: % Using bold here, until we fix #170 diff --git a/docs/authorship.md b/docs/authorship.md index 58da080552..f3b35e86a2 100644 --- a/docs/authorship.md +++ b/docs/authorship.md @@ -4,7 +4,7 @@ A MyST project can include metadata about the authors of each page, such as inst ## How to set author information -Author information is set with [MyST frontmatter](./frontmatter.md). +Author information is set in the [MyST frontmatter](./frontmatter.md). You can set this either in **`myst.yml`** (in which case, they will apply to all documents in a MyST project), or in the **page frontmatter** (in which case they'll just apply to that page). For example, the examples below show frontmatter for authors and [author affiliations](#affiliations) in frontmatter of an `article.md` file, and in `myst.yml`: @@ -53,7 +53,7 @@ See [the `authors` frontmatter reference](#frontmatter:authors) for a list of al ### Re-use author information across repositories and projects By [extending MyST configuration files](#composing-myst-yml) you can store author information in one place and re-use it across many other locations. -This allows you to define a source of truth for authorship and affiliations, and reference that over time. For example: +This allows you to define a source of truth for authorship and affiliations, and reference it over time. For example: In one file, you'd define all the author affiliations that are relevant to your project: From 0e4a08f4c13a2da0e234aad75aa33d7a07d74fd4 Mon Sep 17 00:00:00 2001 From: FreekPols Date: Wed, 29 Oct 2025 20:26:58 +0100 Subject: [PATCH 21/22] include instruction for side by side fig --- docs/figures.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/figures.md b/docs/figures.md index c43eafaadd..ad85901898 100644 --- a/docs/figures.md +++ b/docs/figures.md @@ -97,6 +97,23 @@ See [](#my-figure-fruit) for the fruit, and [](#my-figure) to reference both sub When referring to subfigures, the `{number}` that is used includes the parent enumerator by default (that is: `1a` rather than just `a`). To specifically use the sub-enumerator only, you can use the syntax `{subEnumerator}` in your text link which will be replaced with the sub-enumerator (that is: `a` rather than `1a`). +CSS classes can be applied to make subfigures appear side-by-side or in a grid layout. +`:class: grid grid-cols-2 items-end gap-4` +can be used to create a two-column grid of images with aligned bottoms and a gap between them. + +::::{figure} +:class: grid grid-cols-2 items-end gap-4 +:label: fig_combined2 +:width: 100% + +![Banff, Canada](https://github.com/rowanc1/pics/blob/main/banff-wide.png) +![Golden Gate Bridge, San Francisco](https://github.com/rowanc1/pics/blob/main/sfo-wide.png) + +Some lovely pictures +:::: + + + ## Supported Image Formats MyST supports many images formats including `.png`, `.jpg`, `.gif`, `.tiff`, `.svg`, `.pdf`, and `.eps`. From d683a7a62bfe17ea293b8ffad3f1967c76bad046 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 24 Nov 2025 09:51:01 +0000 Subject: [PATCH 22/22] =?UTF-8?q?=F0=9F=9A=80=20Release?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .changeset/grumpy-cobras-thank.md | 7 ------ .changeset/lucky-tools-behave.md | 5 ---- .changeset/red-yaks-rule.md | 5 ---- package-lock.json | 32 +++++++++++++------------- packages/myst-cli/CHANGELOG.md | 13 +++++++++++ packages/myst-cli/package.json | 10 ++++---- packages/myst-common/CHANGELOG.md | 7 ++++++ packages/myst-common/package.json | 6 ++--- packages/myst-config/CHANGELOG.md | 8 +++++++ packages/myst-config/package.json | 6 ++--- packages/myst-frontmatter/CHANGELOG.md | 2 ++ packages/myst-frontmatter/package.json | 2 +- packages/myst-migrate/CHANGELOG.md | 2 ++ packages/myst-migrate/package.json | 2 +- packages/myst-spec-ext/CHANGELOG.md | 6 +++++ packages/myst-spec-ext/package.json | 2 +- packages/mystmd/CHANGELOG.md | 2 ++ packages/mystmd/package.json | 4 ++-- 18 files changed, 72 insertions(+), 49 deletions(-) delete mode 100644 .changeset/grumpy-cobras-thank.md delete mode 100644 .changeset/lucky-tools-behave.md delete mode 100644 .changeset/red-yaks-rule.md diff --git a/.changeset/grumpy-cobras-thank.md b/.changeset/grumpy-cobras-thank.md deleted file mode 100644 index ff597adc40..0000000000 --- a/.changeset/grumpy-cobras-thank.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -"myst-cli": patch -"myst-common": patch -"myst-spec-ext": patch ---- - -Add support for notebook cell output scroll metadata diff --git a/.changeset/lucky-tools-behave.md b/.changeset/lucky-tools-behave.md deleted file mode 100644 index d1a7c8958a..0000000000 --- a/.changeset/lucky-tools-behave.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'myst-cli': patch ---- - -Fix static build inclusion of sitemap diff --git a/.changeset/red-yaks-rule.md b/.changeset/red-yaks-rule.md deleted file mode 100644 index 9544010dfc..0000000000 --- a/.changeset/red-yaks-rule.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'myst-cli': patch ---- - -Drop hide_authors handling in mystmd diff --git a/package-lock.json b/package-lock.json index a15fc2468e..5b186e2891 100644 --- a/package-lock.json +++ b/package-lock.json @@ -15316,7 +15316,7 @@ } }, "packages/myst-cli": { - "version": "1.6.6", + "version": "1.6.7", "license": "MIT", "dependencies": { "@jupyterlab/services": "^7.3.0", @@ -15346,8 +15346,8 @@ "meca": "^1.0.8", "mime-types": "^2.1.35", "myst-cli-utils": "^2.0.12", - "myst-common": "^1.9.0", - "myst-config": "^1.9.0", + "myst-common": "^1.9.1", + "myst-config": "^1.9.1", "myst-execute": "^0.3.0", "myst-ext-button": "^0.0.1", "myst-ext-card": "^1.0.9", @@ -15357,10 +15357,10 @@ "myst-ext-proof": "^1.0.12", "myst-ext-reactive": "^1.0.9", "myst-ext-tabs": "^1.0.9", - "myst-frontmatter": "^1.9.0", + "myst-frontmatter": "^1.9.1", "myst-parser": "^1.6.1", "myst-spec": "^0.0.5", - "myst-spec-ext": "^1.9.0", + "myst-spec-ext": "^1.9.1", "myst-templates": "^1.0.26", "myst-to-docx": "^1.0.15", "myst-to-jats": "^1.0.34", @@ -15537,11 +15537,11 @@ } }, "packages/myst-common": { - "version": "1.9.0", + "version": "1.9.1", "license": "MIT", "dependencies": { "mdast": "^3.0.0", - "myst-frontmatter": "^1.9.0", + "myst-frontmatter": "^1.9.1", "myst-spec": "^0.0.5", "nanoid": "^5.1.6", "unified": "^10.1.2", @@ -15554,7 +15554,7 @@ "devDependencies": { "@jupyterlab/nbformat": "^3.5.2", "@lumino/coreutils": "^2.0.0", - "myst-spec-ext": "^1.9.0", + "myst-spec-ext": "^1.9.1", "unist-builder": "3.0.0" } }, @@ -15565,11 +15565,11 @@ "dev": true }, "packages/myst-config": { - "version": "1.9.0", + "version": "1.9.1", "license": "MIT", "dependencies": { - "myst-common": "^1.9.0", - "myst-frontmatter": "^1.9.0", + "myst-common": "^1.9.1", + "myst-frontmatter": "^1.9.1", "simple-validators": "^1.1.1" }, "devDependencies": { @@ -15729,7 +15729,7 @@ } }, "packages/myst-frontmatter": { - "version": "1.9.0", + "version": "1.9.1", "license": "MIT", "dependencies": { "credit-roles": "^2.1.0", @@ -15748,7 +15748,7 @@ } }, "packages/myst-migrate": { - "version": "1.6.6", + "version": "1.6.7", "license": "MIT", "dependencies": { "unist-util-select": "^4.0.3", @@ -15807,7 +15807,7 @@ } }, "packages/myst-spec-ext": { - "version": "1.9.0", + "version": "1.9.1", "license": "MIT", "dependencies": { "myst-spec": "^0.0.5" @@ -16096,7 +16096,7 @@ } }, "packages/mystmd": { - "version": "1.6.6", + "version": "1.6.7", "license": "MIT", "bin": { "myst": "dist/myst.cjs" @@ -16106,7 +16106,7 @@ "commander": "^10.0.1", "core-js": "^3.31.1", "js-yaml": "^4.1.0", - "myst-cli": "^1.6.6" + "myst-cli": "^1.6.7" } }, "packages/mystmd-ext-icon": { diff --git a/packages/myst-cli/CHANGELOG.md b/packages/myst-cli/CHANGELOG.md index 5ba8c82841..22339f6b5b 100644 --- a/packages/myst-cli/CHANGELOG.md +++ b/packages/myst-cli/CHANGELOG.md @@ -1,5 +1,18 @@ # myst-cli +## 1.6.7 + +### Patch Changes + +- a742dda: Add support for notebook cell output scroll metadata +- 39570e5: Fix static build inclusion of sitemap +- ae32040: Drop hide_authors handling in mystmd +- Updated dependencies [a742dda] + - myst-common@1.9.1 + - myst-spec-ext@1.9.1 + - myst-config@1.9.1 + - myst-frontmatter@1.9.1 + ## 1.6.6 ## 1.6.5 diff --git a/packages/myst-cli/package.json b/packages/myst-cli/package.json index 1deccc3c5d..3bf985d49d 100644 --- a/packages/myst-cli/package.json +++ b/packages/myst-cli/package.json @@ -1,6 +1,6 @@ { "name": "myst-cli", - "version": "1.6.6", + "version": "1.6.7", "description": "Command line tools for MyST", "author": "Franklin Koch ", "license": "MIT", @@ -69,8 +69,8 @@ "meca": "^1.0.8", "mime-types": "^2.1.35", "myst-cli-utils": "^2.0.12", - "myst-common": "^1.9.0", - "myst-config": "^1.9.0", + "myst-common": "^1.9.1", + "myst-config": "^1.9.1", "myst-execute": "^0.3.0", "myst-ext-button": "^0.0.1", "myst-ext-card": "^1.0.9", @@ -80,10 +80,10 @@ "myst-ext-proof": "^1.0.12", "myst-ext-reactive": "^1.0.9", "myst-ext-tabs": "^1.0.9", - "myst-frontmatter": "^1.9.0", + "myst-frontmatter": "^1.9.1", "myst-parser": "^1.6.1", "myst-spec": "^0.0.5", - "myst-spec-ext": "^1.9.0", + "myst-spec-ext": "^1.9.1", "myst-templates": "^1.0.26", "myst-to-docx": "^1.0.15", "myst-to-jats": "^1.0.34", diff --git a/packages/myst-common/CHANGELOG.md b/packages/myst-common/CHANGELOG.md index 677b7b2f0b..60ff55f898 100644 --- a/packages/myst-common/CHANGELOG.md +++ b/packages/myst-common/CHANGELOG.md @@ -1,5 +1,12 @@ # myst-common +## 1.9.1 + +### Patch Changes + +- a742dda: Add support for notebook cell output scroll metadata + - myst-frontmatter@1.9.1 + ## 1.9.0 ### Patch Changes diff --git a/packages/myst-common/package.json b/packages/myst-common/package.json index 2a5c60c0eb..5c15fe55f4 100644 --- a/packages/myst-common/package.json +++ b/packages/myst-common/package.json @@ -1,7 +1,7 @@ { "name": "myst-common", "sideEffects": false, - "version": "1.9.0", + "version": "1.9.1", "type": "module", "exports": "./dist/index.js", "types": "./dist/index.d.ts", @@ -21,7 +21,7 @@ }, "dependencies": { "mdast": "^3.0.0", - "myst-frontmatter": "^1.9.0", + "myst-frontmatter": "^1.9.1", "myst-spec": "^0.0.5", "nanoid": "^5.1.6", "unified": "^10.1.2", @@ -32,7 +32,7 @@ "vfile-message": "^3.0.0" }, "devDependencies": { - "myst-spec-ext": "^1.9.0", + "myst-spec-ext": "^1.9.1", "unist-builder": "3.0.0", "@jupyterlab/nbformat": "^3.5.2", "@lumino/coreutils": "^2.0.0" diff --git a/packages/myst-config/CHANGELOG.md b/packages/myst-config/CHANGELOG.md index a9ff7c3ed9..ddc29ed6ac 100644 --- a/packages/myst-config/CHANGELOG.md +++ b/packages/myst-config/CHANGELOG.md @@ -1,5 +1,13 @@ # myst-config +## 1.9.1 + +### Patch Changes + +- Updated dependencies [a742dda] + - myst-common@1.9.1 + - myst-frontmatter@1.9.1 + ## 1.9.0 ### Patch Changes diff --git a/packages/myst-config/package.json b/packages/myst-config/package.json index ea65f72c05..f4ce9b175f 100644 --- a/packages/myst-config/package.json +++ b/packages/myst-config/package.json @@ -1,6 +1,6 @@ { "name": "myst-config", - "version": "1.9.0", + "version": "1.9.1", "license": "MIT", "description": "Project and site config types and validation for the mystmd ecosystem", "author": "Franklin Koch ", @@ -31,8 +31,8 @@ "url": "https://github.com/jupyter-book/mystmd/issues" }, "dependencies": { - "myst-common": "^1.9.0", - "myst-frontmatter": "^1.9.0", + "myst-common": "^1.9.1", + "myst-frontmatter": "^1.9.1", "simple-validators": "^1.1.1" }, "devDependencies": { diff --git a/packages/myst-frontmatter/CHANGELOG.md b/packages/myst-frontmatter/CHANGELOG.md index c943fd617f..fa962f8b91 100644 --- a/packages/myst-frontmatter/CHANGELOG.md +++ b/packages/myst-frontmatter/CHANGELOG.md @@ -1,5 +1,7 @@ # myst-frontmatter +## 1.9.1 + ## 1.9.0 ### Minor Changes diff --git a/packages/myst-frontmatter/package.json b/packages/myst-frontmatter/package.json index 060dbd1118..f28188c1d6 100644 --- a/packages/myst-frontmatter/package.json +++ b/packages/myst-frontmatter/package.json @@ -1,6 +1,6 @@ { "name": "myst-frontmatter", - "version": "1.9.0", + "version": "1.9.1", "sideEffects": false, "license": "MIT", "description": "Frontmatter types and validation for the mystmd ecosystem", diff --git a/packages/myst-migrate/CHANGELOG.md b/packages/myst-migrate/CHANGELOG.md index d600ef6e61..05a67ce469 100644 --- a/packages/myst-migrate/CHANGELOG.md +++ b/packages/myst-migrate/CHANGELOG.md @@ -1,5 +1,7 @@ # myst-migrate +## 1.6.7 + ## 1.6.6 ## 1.6.5 diff --git a/packages/myst-migrate/package.json b/packages/myst-migrate/package.json index 70a73a3c3e..bca3213dd7 100644 --- a/packages/myst-migrate/package.json +++ b/packages/myst-migrate/package.json @@ -1,7 +1,7 @@ { "name": "myst-migrate", "sideEffects": false, - "version": "1.6.6", + "version": "1.6.7", "type": "module", "exports": "./dist/index.js", "types": "./dist/index.d.ts", diff --git a/packages/myst-spec-ext/CHANGELOG.md b/packages/myst-spec-ext/CHANGELOG.md index e7a4e2e34b..09a86c4e19 100644 --- a/packages/myst-spec-ext/CHANGELOG.md +++ b/packages/myst-spec-ext/CHANGELOG.md @@ -1,5 +1,11 @@ # myst-spec-ext +## 1.9.1 + +### Patch Changes + +- a742dda: Add support for notebook cell output scroll metadata + ## 1.9.0 ### Patch Changes diff --git a/packages/myst-spec-ext/package.json b/packages/myst-spec-ext/package.json index 62e69a22e8..bc85690a7b 100644 --- a/packages/myst-spec-ext/package.json +++ b/packages/myst-spec-ext/package.json @@ -1,6 +1,6 @@ { "name": "myst-spec-ext", - "version": "1.9.0", + "version": "1.9.1", "description": "Extensions for myst-spec that are used in mystmd", "author": "Rowan Cockett ", "homepage": "https://github.com/jupyter-book/mystmd/tree/main/packages/myst-spec-ext", diff --git a/packages/mystmd/CHANGELOG.md b/packages/mystmd/CHANGELOG.md index 13141e4f21..1f82254fff 100644 --- a/packages/mystmd/CHANGELOG.md +++ b/packages/mystmd/CHANGELOG.md @@ -1,5 +1,7 @@ # mystmd +## 1.6.7 + ## 1.6.6 ### Patch Changes diff --git a/packages/mystmd/package.json b/packages/mystmd/package.json index 6a2580286d..92e413ef34 100644 --- a/packages/mystmd/package.json +++ b/packages/mystmd/package.json @@ -1,6 +1,6 @@ { "name": "mystmd", - "version": "1.6.6", + "version": "1.6.7", "description": "Command line tools for MyST Markdown", "author": "Rowan Cockett ", "license": "MIT", @@ -45,6 +45,6 @@ "commander": "^10.0.1", "core-js": "^3.31.1", "js-yaml": "^4.1.0", - "myst-cli": "^1.6.6" + "myst-cli": "^1.6.7" } }