Skip to content

Add an embed role - #2648

Open
tylere wants to merge 7 commits into
jupyter-book:mainfrom
tylere:embed-text
Open

Add an embed role#2648
tylere wants to merge 7 commits into
jupyter-book:mainfrom
tylere:embed-text

Conversation

@tylere

@tylere tylere commented Jan 16, 2026

Copy link
Copy Markdown
Contributor

Adds an embed role to include content inline.
Adds documentation.

Fixes #2646.

This is my first time trying to add a role, following the Adding a New MyST Feature docs. Claude Code helped too. Suggestions appreciated. I realize this may not be the best way to implement the feature, especially given the work on #1961.

@changeset-bot

changeset-bot Bot commented Jan 16, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 3c5de4b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 12 packages
Name Type
myst-common Minor
myst-roles Minor
myst-cli Minor
myst-config Minor
myst-frontmatter Minor
myst-spec-ext Minor
myst-parser Minor
myst-directives Minor
myst-to-html Minor
mystmd Minor
myst-migrate Minor
myst-transforms Patch

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

@tylere

tylere commented Jan 16, 2026

Copy link
Copy Markdown
Contributor Author

This issue has a failing check because it is not labeled. It should be labeled as "enhancement", but I don't have sufficient permissions to add the label.

@tylere
tylere marked this pull request as ready for review January 16, 2026 19:57
@choldgraf choldgraf added the enhancement New feature or request label Jan 16, 2026
@rowanc1

rowanc1 commented Jun 2, 2026

Copy link
Copy Markdown
Member

This is awesome - very into this feature having a role that is equivalent to the directive makes a ton of sense. Haven't had a chance to look at it specifically yet though!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Add an {embed} role for inserting labeled content inline

3 participants