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

VitePress migration #2479

Merged
merged 24 commits into from
Sep 27, 2024
Merged

Conversation

lifehackerhansol
Copy link
Contributor

@lifehackerhansol lifehackerhansol commented Sep 20, 2024

Description

Due to the age and the infeasibility to update the out-of-tree fork of minimal mistakes, I propose we migrate to VitePress.

No features of the guide are lost as of the migration.

Note that all translations will need to be disabled upon migration as the current markdown will not work as is and Crowdin will need to regenerate them.

Progress:

  • Add initial configuration and theme
  • Migrate English docs to VitePress
  • Add translation framework
  • Fix navigation bar overflowing issue due to too many items
  • Restore minimal mistakes style hero image
  • Move theme to submodule to be reused across hacks.guide
  • General system stability improvements to enhance the user's experience

@lifehackerhansol lifehackerhansol changed the title Vitepress VitePress migration Sep 20, 2024
@lifehackerhansol lifehackerhansol marked this pull request as ready for review September 22, 2024 22:59
- Add theme submodule
- Add initial configuration files
- Override theme-default VPHero/VPFooter with custom theme version
- Update README
Things that happen in this shameless squash:
- Removed 404 page
  - It doesn't work in VitePress and making it work in VitePress needs
    some invasive hack in the theme that I'm not willing to do
  - The default is more than enough, though
- Moved consoleVersionSelect include to another directory
  - This avoids being uploaded to Crowdin for translation
- Inline all SafeB9SInstaller includes
  - Not only do parameterized includes not work, but if/else statements
    don't work at all
- The sysupdate include parameter hasn't been used since MSET9, so it
  actually works just fine without any parameters. Hooray(?)
- Move mset9-chorus to an include, that logic doesn't work in VitePress
- Removed Get Started button from homepage, it breaks translations
- Tables in get-started are now shown by default; it seems VitePress really does
  not want us to use inline script. So we cannot enable it upon
  realizing that the browser is JS capable
- Include parameters are now in frontmatter to allow translation
- Hacked in a bunch of CSS values kanged from the old theme to make it
  look not stupid
- Drop headers down one level to make table of contents work
The image is taken from [0], and processed with ImageMagick:
`convert chromeos.png -trim -resize 600x`

This fixes the issue of the logo being invisible in light mode.

[0]: https://partnermarketinghub.withgoogle.com/brands/chromebook/chromebook/visual-identity/visual-identity/logos-and-badges/
All previous copyrights held in this repository were related to the
old theme which is no longer in use.
They don't work the way our guide does. Our guide, for a lack of a
better word, interleaves between paths, so the next button is almost
always incorrect.

We have always added a button to the correct next page manually anyway,
so just rely on that.
This allows to show more than just h2, which is needed for the
section numbers that currently use h3.
These should not be in the final build. It also breaks build with dead
link checks enabled, which is default.
These need to be regenerated by Crowdin.
To allow these to be linked to.
Jekyll is no longer used.
@lifehackerhansol lifehackerhansol merged commit bc555ec into hacks-guide:master Sep 27, 2024
1 check passed
@lifehackerhansol lifehackerhansol deleted the vitepress branch October 2, 2024 12:08
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.

1 participant