-
Notifications
You must be signed in to change notification settings - Fork 27
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
Migrate framework to VitePress #29
Conversation
…w license attributions
This PR is feature complete except for:
all of which I will be added to this PR shortly if you'd like to preview the new wiki locally run |
I would love any specific thoughts on this @MaxWasUnavailable @Xilophor. I have tried to make the transition as smooth as possible: hosting and writing new articles should be essentially identical Contributing should also be more directly accessible with the "Edit this page" button. I'd like to write up a contributing guide like bsmg.wiki has at some point |
What do you mean by |
Ah yeah I dropped a word there, I specifically meant Algolia search so we can have more relevant search than just "search the exact phrase" What docsify has works alright, but I do think having something that supports synonyms/more complicated queries would be nice, especially as the site grows |
The r2modman page runs a query to thunderstore to get the latest r2modman version, I just need to reimplement it for the new framework Honestly we might want to remove this at some point, it's fairly minor and I don't want to accidentally burden thunderstore with massive amounts of traffic - i'll probably make an issue later |
Docsify did have a search function, although it doesn't seem great. Looking at the exact same search in the new one, it gives a much better preview (if enabled).
Looking at a potential search, it does seem to better support/sort based on complicated searches that don't exactly match the content. Example search: |
Right now it's just using vitepress's (solid) local search, but once it's deployed and had some time to simmer I'll try to set it up with Algolia, which should be even better |
If that's just the local search, I can't wait to see what Algolia looks like. Any timeline on when you plan to add that as a PR/to this PR? |
One of the people I consulted with about frameworks specifically said it's a bit of a process to set up, so it'll probably be a week or two |
I've just removed this for now. It's neat but I'm worried it's not helping with the thunderstore downtime I'll look into doing it on build time in a separate PR |
Translation also needs to be fixed in a separate PR because I think the only way to get crowdin to register the new changes is pulling them into main |
Looks superb! Great work @legoandmars |
There's a few things about docsify that have been personally bothering me and (IMO) are hampering the wiki a bit. There's some details in #12 and #26.
Basically:
This PR converts the wiki to use VitePress, a similar framework that also uses .md files
There were minimal markdown-changes that had to be made, I simply
! >
) to vitepress's formatting (::: warning
)This will make embeds look significantly better, and help the site a LOT on google rankings, hopefully getting the wiki recommended instead of random outdated articles
Here's a preview of how the new styling looks:
Embeds also look significantly better now, here's before and after (notice how each linked page will now actually show proper page-specific metadata)
This also adds the following features: