Utilitarianism.net

Official code for the utilitarianism.net website.

We are using Hugo to build the base website and a few npm packages and scripts to generate PDFs, add search functionality, etc.

Developing

If you're new to coding, see the detailed instructions.

First time:

• Install Hugo (current version is 0.124.0 extended edition)

Any time after:

hugo serve

Building

First time:

• install Node
• install just
• run npm install¹

Any time after:

npm run build

The /public folder now contains all the static files. The /dist folder now has the zip of them all: upload to your webhost, unzip, and you are done 🤩

For more details see instructions/README.md

Languages

This website can be built in different languages, one language at a time. You must manually change config.toml to pick the language and disable all others:

• defaultContentLanguage = "en"
• disableLanguages = ["es", "de"]

Adding documents

You can easily import Google Documents via Docs to Markdown. see instructions/README.md for more info.

Notes

See instructions/README.md for more useful information about getting started with or working on this project.

Thank you

A huge thank you to the numerous creators and contributors that make building new things possible, easier, and a pleasure.

Thank you to the libraries without which our website would not be possible or would be less than it is now:

• hugo for building the website HTML
• pagefind for generating the search index
• website2pdf for generating PDFs

Thank you to supporting libraries that make the process of building better:

• theme/ananke for helping set up this Hugo project
• just for handle building scripts
• fdir for the fastest way to crawl a directory
• bestzip for zipping the finished files into one
• serve for previewing the final build

This is not a complete list, there are too many others to list 🙇‍♂️

Footnotes

1. If you see a Pagefind Error: tar xvf exited with 128 try using Powershell ↩