-
Notifications
You must be signed in to change notification settings - Fork 82
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 #230
base: master
Are you sure you want to change the base?
VitePress migration #230
Conversation
adac78b
to
bffd5d0
Compare
6d0a21d
to
c58060c
Compare
2b50d06
to
8b30a0f
Compare
- Add theme submodule - Add initial configuration files - Override theme-default VPFooter with custom theme version
While the docs are licensed under ISC, the theme is licensed under MIT. Explicitly specify this.
Things that happen in this massive commit: - Converted admonitions to VitePress - Converted tabs to VitePress - Adjusted headings for VitePress - Absolute link-ify downloads, which works since we are now on switch.hacks.guide - Remove linking to `.md` directly, use the pretty URL
This retires the old logo, and brings in Plailect's old Switch guide image.
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.
Specifying `tab default` will allow defaulting to this tab on page load.
Buttons don't really work that well in VitePress, thus this emoji is also unneeded.
8b30a0f
to
17f15fb
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Haven't scrolled through the web preview yet, but i see nothing weird changed in the markdown. Well done.
@@ -3,53 +3,52 @@ name: Deploy site | |||
on: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(Unrelated to this file)
Do you think it's worth having a CI build check linting, so after you fixing stuff it stays consistent?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't know of any particular one; would be nice to have though.
|
||
### **Disadvantages of AutoRCM** | ||
You really want to kill your console, huh? If you haven't made a BOOT0/1 backup yet, it is recommended to make one **right now**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unrelated to this PR, but we may want to check for such snarky comments in the future, and remove them.
If you update from below Atmosphère 1.0.0, there are additional steps to follow. You will have to delete the `sept` folder from your microSD, delete `fusee-secondary.bin` from your `atmosphere` folder and update your Hekate config file: <a href="../../files/emu/hekate_ipl.ini" download>hekate_ipl.ini</a> in the `bootloader` folder. | ||
::: warning | ||
|
||
**Updating from below Atmosphère 1.0.0** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unrelated to this PR, but we're on atmosphere 1.8.0. I don't expect anyone to still be on something below 1.0.0.
|
||
----- | ||
NX-Shell is a file manager. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unrelated to this PR, but probably should expand this to 'NX-Shell is an on-console file manager, able to be launched from the homebrew menu'. Such a short introduction sounds odd to me.
@@ -4,12 +4,17 @@ This page documents how you can keep your system up-to-date. | |||
|
|||
After following our guide, your system will consist of three core elements that can be updated. Atmosphere, Hekate and your system firmware. | |||
|
|||
### **Updating Atmosphere** | |||
## Updating Atmosphere |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unrelated to this PR, but we should probably expand this page to feature common errors, and additional steps users may have to take (like updating/removing sysmodules).
May also be worth splitting this page off in 2 sepearte pages, one to update the firmware, one to update cfw.
|
||
For live support with this guide, visit us in **#switch-assistance-1** or **#switch-assistance-2** over at the [NH-Discord server](https://discord.gg/C29hYvh). | ||
--- | ||
layout: home |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where are these layouts defined?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's built into VitePress. https://vitepress.dev/reference/default-theme-layout
| 1.0.0 | Nereba or [**RCM**](rcm/index) | **N/A** | **N/A** | **N/A** | | ||
| 2.0.0 - 3.0.2 | Caffeine or [**RCM**](rcm/index) | **N/A** | **N/A** | **N/A** | | ||
| 4.0.0 - 4.1.0 | Caffeine or [**RCM**](rcm/index) | Caffeine | **N/A** | **N/A** | | ||
| 5.0.0 - 7.0.0 | [**RCM**](rcm/index) | [**Modchip**](modchip/index) / Wait for CFW | **N/A** | **N/A** | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I doubt this will ever happen lol (The 'wait for cfw')
Description
In line with the other hacks-guide migrations, I have applied the same migration here.
Currently buttons do not work as well as it did on mkdocs, so this was switched to an admonition, similar to how the 3DS guide operates. There doesn't seem to be a much better option.