vrchatapi / vrchatapi.github.io

✨ VRChat API Documentation - A Community-Driven API documentation project.
https://vrchatapi.github.io
MIT License
218 stars 43 forks source link

Migrate to Hugo #91

Closed Foorack closed 2 years ago

Foorack commented 2 years ago

This PR migrates away from Jekyll and instead uses Hugo.

Jekyll is a blog-aware, static site generator written in Ruby that allows you to create a website with Markdown files and templates. We don't use the blogging-part of it, but it offers includes in HTML, which can be extremely powerful. The problem with this is that it introduces a hard-dependency on Ruby just to build the website. Installing Ruby, bundler, jekyll, and then gem-install'ing all the dependencies on Windows just to build the website is neither easy nor fun.

Hugo is a blazing fast static site generator written in Go. Hugo is 23 to 63 times faster than Jekyll and most importantly can be distributed inside the repository as a portable binary. This would dramatically simplify the set-up for people who want to contribute to the website and try build it on their local machine to see the result before they commit.

The website has been re-created and should look completely identical, except for some minor differences:

I will write HOWTO_CONTRIBUTE instructions and include the hugo binaries in an upcoming PR. But for now it's just to download the executable and run it with ./hugo server.

cloudflare-pages[bot] commented 2 years ago

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 45264fb
Status: ✅  Deploy successful!
Preview URL: https://37bb7c19.vrchatapi.pages.dev

View logs