Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

␡ Enable strikethrough as markdownit extension #1427

Merged
merged 3 commits into from
Aug 21, 2024

Conversation

sglyon
Copy link
Contributor

@sglyon sglyon commented Aug 7, 2024

Ends up parsing out to a delete node and uses the rendering logic for the delete directive

Ends up parsing out to a `delete` node and uses the rendering logic for the delete directive
Copy link

changeset-bot bot commented Aug 7, 2024

🦋 Changeset detected

Latest commit: fcbcd94

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

This PR includes changesets to release 5 packages
Name Type
myst-parser Patch
myst-roles Patch
myst-directives Patch
myst-to-html Patch
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

@sglyon
Copy link
Contributor Author

sglyon commented Aug 12, 2024

Thanks for adding those tasty-fireants!

Is this one good to go?

@sglyon
Copy link
Contributor Author

sglyon commented Aug 20, 2024

Hi @rowanc1 is this ready to merge?

@agoose77 agoose77 requested a review from rowanc1 August 21, 2024 09:34
@rowanc1 rowanc1 changed the title feat: enable strikethrough as markdownit extension ␡ Enable strikethrough as markdownit extension Aug 21, 2024
@rowanc1
Copy link
Collaborator

rowanc1 commented Aug 21, 2024

Added a test - thanks for the nudge.

Will get this in when it goes green!

@@ -75,6 +76,7 @@ export function createTokenizer(opts?: Options) {
if (markdownit.linkify) {
tokenizer.linkify.tlds(tlds.filter((tld) => !EXCLUDE_TLDS.includes(tld)));
}
if (extensions.strikethrough) tokenizer.enable('strikethrough');
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: This is not enabled by default and I am not sure if there is a way to turn this on from the CLI quite yet. We can add those features in future!

@rowanc1 rowanc1 merged commit 1a5f3f3 into jupyter-book:main Aug 21, 2024
7 checks passed
@rowanc1
Copy link
Collaborator

rowanc1 commented Aug 21, 2024

Thanks @sglyon for your help!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants