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

fix: update styles and resolve vitepress conflicts #70

Merged
merged 4 commits into from
Aug 30, 2022
Merged

fix: update styles and resolve vitepress conflicts #70

merged 4 commits into from
Aug 30, 2022

Conversation

brc-dd
Copy link
Member

@brc-dd brc-dd commented Aug 24, 2022

fixes #69
fixes #72

@skirtles-code
Copy link
Contributor

This PR introduces some changes to the styling of the code itself:

image

In particular, notice the italics.

The code on the left is using the existing theme, whereas the code on the right is using this PR. The code style on the left is what you'll currently see in the Vue 3 docs (even after the VitePress 1 upgrade), but the code on the right is more consistent with the default VitePress 1 theme.

Whether this is actually a problem I'll leave for others to decide.

package.json Show resolved Hide resolved
@brc-dd
Copy link
Member Author

brc-dd commented Aug 27, 2022

@skirtles-code Seems like some issue with shiki's latest version. I've created an issue on their repo: shikijs/shiki#343

@brc-dd brc-dd marked this pull request as draft August 30, 2022 04:50
@brc-dd brc-dd marked this pull request as ready for review August 30, 2022 05:00
@brc-dd brc-dd marked this pull request as draft August 30, 2022 05:12
@brc-dd brc-dd changed the title fix: update code block styles fix: update styles and resolve vitepress conflicts Aug 30, 2022
@brc-dd brc-dd requested a review from Jinjiang August 30, 2022 05:24
@brc-dd
Copy link
Member Author

brc-dd commented Aug 30, 2022

There are some additional changes:

  1. VitePress recently refactored markdown related stuff to a separate repo. It appears that we need to properly bundle its types. There are certain changes in the header types since the refactor, I've changed the code accordingly.
    Also, temporarily I've added @mdit-vue/types package to resolve types properly (we can remove that once vitepress#1254 is resolved).

  2. VitePress has now in-built dark mode support. So there is no need to inject any custom script. I have updated the light/dark mode key accordingly.

@brc-dd brc-dd marked this pull request as ready for review August 30, 2022 05:49
@yyx990803 yyx990803 merged commit 923735f into vuejs:main Aug 30, 2022
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.

Dark/Light mode choice is not being preserved Duplicated language specifier in code blocks
4 participants