This is my wiki. There are many like it, but this one is mine.

Theme heavily inspired by Sphinx theme for readthedocs.org

(Includes bundle, gem, and header files for installing native modules)

sudo apt install ruby ruby-bundler ruby-dev

https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/

bundle exec jekyll serve --livereload

See this answer if you get this error:

/var/lib/gems/3.0.0/gems/pathutil-0.16.2/lib/pathutil.rb:502:in `read': no implicit conversion of Hash into Integer (TypeError)

This is particularly useful if Github bugs you that you have a security vulnerability in one of your dependencies (this has been remedied for this project by removing Gemfile.lock from git 🤷)

rm Gemfile.lock
bundle install

This project uses HTMLProofer to check for broken internal links. To test locally with HTMLProofer:

1. Build the site

   bundle exec jekyll build
   

2. Get the parameters used for HTMLProofer in GitHub Actions here: .github/workflows/ci.yml

3. Run HTMLProofer

   docker run --rm --entrypoint "htmlproofer" -v "$PWD:/work" -it anishathalye/proof-html:1.4.0 /work/_site --assume_extension --disable-external --empty-alt-ignore --url-ignore "_,#" --url-swap "^/wiki:"