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

Upgrade VuePress to 1.0 #770

Closed
jlowin opened this issue Mar 21, 2019 · 8 comments · Fixed by #1408
Closed

Upgrade VuePress to 1.0 #770

jlowin opened this issue Mar 21, 2019 · 8 comments · Fixed by #1408
Labels

Comments

@jlowin
Copy link
Member

jlowin commented Mar 21, 2019

No description provided.

@jlowin
Copy link
Member Author

jlowin commented Mar 22, 2019

Quick notes from trying this and using the suggested migrations:

  • this bug appears to block many Prefect styles; I have to put all code in palette.styl (only global colors are supposed to be put there) to get it to load and even then this theme.styl overrides some things

@ngansequitur
Copy link

@jlowin did you already upgrade to vuepress 1.0 and run into this? just need to know the steps i need to take here :)

@jlowin
Copy link
Member Author

jlowin commented Mar 27, 2019

Yes, I actually have a branch that I just pushed called vuepress-1.x which has some of my upgrade changes (and probably some unwanted code bc i was messing around) -- we can pair on that later this week maybe to see what's up

@jlowin
Copy link
Member Author

jlowin commented Mar 27, 2019

The only remaining blocker is the syntax highlighting, I've solved the rest (though a couple class names changed so we'll need to review for some that aren't picking up our styles)

@cicdw cicdw added this to the v0.5.2 milestone Apr 6, 2019
@cicdw cicdw added the blocked label Apr 15, 2019
@jlowin
Copy link
Member Author

jlowin commented Apr 16, 2019

Just walked through with @dylanbhughes and our conclusion is that VuePress is not ready at this time. The dev server and actual build give very different output right now. Ironically, the built output is close to "correct" but the dev server is not. We will stick to pre-1.0 until this is resolved, as the UX of working with a dev server that doesn't reflect reality is terrible. In particular, the syntax highlighting is illegible.

Dev server:
image

Built:
image

Dev server:
image

Built:
image

@ngansequitur
Copy link

ngansequitur commented Apr 19, 2019

looks like they recently made a fix with the latest vuepress release 1.0.0-alpha.47 — see changelog for more info. went ahead and upgraded along with few changes to get syntax highlighting to work on dev so it should match production build now! pushed changes to your vuepress-1.x branch via commit 9dc521f but didn't want to create a PR until we're all on board.

a lot of the styling mishaps i noticed is due to their structural changes in 1.x as well. they changed a lot of their structure to use semantic HTML as well as updated some class names so i'll make another branch for styling-specific changes!

@jlowin
Copy link
Member Author

jlowin commented Apr 19, 2019

Thanks @itsngansense! Confirm we're now unblocked by that issue. Unfortunately it looks like sidebarDepth: 0 is no longer respected, trying to understand if that's a bug or a feature.

@jlowin
Copy link
Member Author

jlowin commented Apr 19, 2019

In addition, the top-level sidebar name for all API references is wrong, it appears not to look through the HTML at the top of the README.md

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

Successfully merging a pull request may close this issue.

3 participants