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(vuepress): fix Vuepress live preview plugin configuration based o… #234

Merged
merged 1 commit into from
Oct 12, 2021

Conversation

manoj-krishnan
Copy link
Contributor

@manoj-krishnan manoj-krishnan commented Oct 11, 2021

…n latest version

With the shift to the monorepo setup, this repository now runs on Node 14.x (due to the need for npm
7+). Switching to this version of Node JS has resulted in some packages (mainly vuepress-plugin-live
and it's internal dependency vue-live) getting upgraded to newer versions. Currently, this
repository's Vuepress implementation includes a custom template (www/.vuepress/previewLayout.vue)
that over-rides vue-live's default template. This over-ride template was based on vue-live 0.3.0.
The updated version of vue-live (1.3.0) uses a very different method to render a live code editor
and hence it's template differs slightly (resulting in a series of CSS breakages) - this difference in the
template caused a visual/functional bug in the live-preview parts of the website's UI. This patch updates the
over-ride template in accordance with the default template of vue-live 1.3.0 to fix this issue.

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • My commits have standard messages as mentioned in Contributing Guidelines

How Has This Been Tested?

…n latest version

With the shift to the monorepo setup, this repository now runs on Node 14.x (due to the need for npm
7+). Switching to this version of Node JS has resulted in some packages (mainly vuepress-plugin-live
and it's internal dependency vue-live) getting upgraded to newer versions. Currently, this
repository's Vuepress implementation includes a custom template (www/.vuepress/previewLayout.vue)
that over-rides vue-live's default template. This over-ride template was based on vue-live 0.3.0.
The updated version of vue-live (1.3.0) uses a very different method to render a live code editor
and hence it's template differs slightly - this difference in the template caused a
visual/functional bug in the live-preview parts of the website's UI. This patch updates the
over-ride template in accordance with the default template of vue-live 1.3.0 to fix this issue.
@manoj-krishnan
Copy link
Contributor Author

@asifahmedfw this PR fixes the Vuepress code preview breakage that we discussed today. The commit description captures the issue in detail. Please check and let me know if I've missed anything.

@arvindanta FYI, it was due to the Node version change, but the breakage itself was difficult to trace. I had to dive into the implementation of vue-live to root out the bug, but it's good to go now.

Copy link
Contributor

@asif-ahmed-1990 asif-ahmed-1990 left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@manoj-krishnan manoj-krishnan merged commit 3d18058 into monorepo Oct 12, 2021
@manoj-krishnan manoj-krishnan deleted the vuepress-live-plugin-fixes branch October 12, 2021 05:30
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