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

Move to shiki and stabilize dual themes support #10130

Merged
merged 7 commits into from
Mar 8, 2024
Merged

Conversation

bluwy
Copy link
Member

@bluwy bluwy commented Feb 15, 2024

Changes

shikiji has been merged into shiki 1.0. This PR also moves back to shiki. There weren't any significant changes, so this PR is mainly package name change and small compat code added.

markdown.shikiConfig.experimentalThemes is also stabilized as markdown.shikiConfig.themes together with the move to shiki. It is not considered experimental by shikiji or shiki anymore.

Testing

Existing tests should pass

Docs

I've updated some links in the jsdoc to use the new site https://shiki.style. I've also made a docs PR: withastro/docs#6898

@bluwy bluwy added this to the 4.5 milestone Feb 15, 2024
Copy link

changeset-bot bot commented Feb 15, 2024

🦋 Changeset detected

Latest commit: 4bdd901

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

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

@github-actions github-actions bot added feat: markdown Related to Markdown (scope) pkg: example Related to an example package (scope) pkg: astro Related to the core `astro` package (scope) pr: docs A PR that includes documentation for review semver: minor Change triggers a `minor` release labels Feb 15, 2024
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

This PR is blocked because it contains a minor changeset. A reviewer will merge this at the next release if approved.

@soerenmartius
Copy link

QQ: Wouldn't it make sense to add functionality such as decorators to the <Code/> component apo also?

@bluwy
Copy link
Member Author

bluwy commented Feb 22, 2024

I guess we could too, along with transformers which is already supported in markdown.shikiConfig. I'm not sure what the current stance is for Code.astro since decorators and transformers are shiki-specific features, but I don't mind exposing it.

@soerenmartius
Copy link

I guess we could too, along with transformers which is already supported in markdown.shikiConfig. I'm not sure what the current stance is for Code.astro since decorators and transformers are shiki-specific features, but I don't mind exposing it.

That'd be awesome!

@CaptainOfPhB
Copy link

CaptainOfPhB commented Feb 28, 2024

@bluwy @ematipico Can you fix conflicts and merge them into master? I can't wait to use the new Shiki :)

@bluwy
Copy link
Member Author

bluwy commented Feb 28, 2024

I can fix them up later today, but this will only be merged for the next minor, which is scheduled some time next week. There shouldn't be any significant changes on the user-side though.

Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Approving this (and the accompanying docs PR) for docs!

@ematipico ematipico merged commit 5a95287 into main Mar 8, 2024
14 checks passed
@ematipico ematipico deleted the back-to-shiki branch March 8, 2024 10:53
@astrobot-houston astrobot-houston mentioned this pull request Mar 8, 2024
ematipico added a commit that referenced this pull request Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat: markdown Related to Markdown (scope) pkg: astro Related to the core `astro` package (scope) pkg: example Related to an example package (scope) pr: docs A PR that includes documentation for review semver: minor Change triggers a `minor` release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants