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 #117

Merged
merged 22 commits into from
Sep 27, 2024
Merged

Conversation

lifehackerhansol
Copy link
Collaborator

@lifehackerhansol lifehackerhansol commented Sep 22, 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
  • Restore minimal mistakes style hero image
  • Move theme to submodule to be reused across hacks.guide
  • Figure out what to do about the multilayer tabs in transfer-saves
  • General system stability improvements to enhance the user's experience

@lifehackerhansol lifehackerhansol marked this pull request as ready for review September 24, 2024 23:20
- Add theme submodule
- Add initial configuration files
- Override theme-default VPHero/VPFooter with custom theme version
- Add configuration for tabs
- Update README
- 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
- Inline redirect-wiki.md, it doesn't work in VitePress
  - Use the `head` frontmatter to add the meta-refresh
- Linear-ize transfer-saves
- The current tab implementation doesn't work very well with nested
  tabs such as this page is using. Linearize it and add a table of
  contents for now until a better solution is found
- Drop headers down one level where needed
- Miscellaneous formatting fixes
This is linking to a `wii-saves` page that doesn't exist. And adding
`gcsaves` without `wii-saves` doesn't really make sense, so just remove
the note entirely.
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.
Jekyll is no longer used.
@lifehackerhansol lifehackerhansol merged commit 98589d2 into hacks-guide:master Sep 27, 2024
1 check passed
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