Prefect: Upgrade VuePress to 1.0

Created on 21 Mar 2019  Â·  8Comments  Â·  Source: PrefectHQ/prefect

docs

All 8 comments

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

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

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

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)

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

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!

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.

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

Was this page helpful?
0 / 5 - 0 ratings

Related issues

fgblomqvist picture fgblomqvist  Â·  4Comments

jlowin picture jlowin  Â·  3Comments

GZangl picture GZangl  Â·  3Comments

Trymzet picture Trymzet  Â·  4Comments

dkapitan picture dkapitan  Â·  3Comments