https://github.com/bmaupin/wiki
My wiki
https://github.com/bmaupin/wiki
github-pages jekyll wiki
Last synced: 5 months ago
JSON representation
My wiki
- Host: GitHub
- URL: https://github.com/bmaupin/wiki
- Owner: bmaupin
- License: mit
- Created: 2018-06-07T19:24:31.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2025-09-12T16:44:11.000Z (9 months ago)
- Last Synced: 2025-09-12T18:53:44.817Z (9 months ago)
- Topics: github-pages, jekyll, wiki
- Language: CSS
- Homepage: https://bmaupin.github.io/wiki/
- Size: 647 KB
- Stars: 12
- Watchers: 2
- Forks: 9
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Notice: NOTICE
Awesome Lists containing this project
README
This is my wiki. There are many like it, but this one is mine.
Theme heavily inspired by [Sphinx theme for readthedocs.org](https://github.com/rtfd/sphinx_rtd_theme)
## Development
#### Install Ruby
(Includes bundle, gem, and header files for installing native modules)
```
sudo apt install ruby ruby-bundler ruby-dev
```
#### Install and configure Jekyll
[https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/)
#### Running Jekyll
```
bundle exec jekyll serve --livereload
```
See [this answer](https://stackoverflow.com/a/73909796/399105) 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)
```
#### Updating gems
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
```
## Testing
#### HTMLProofer
This project uses [HTMLProofer](https://github.com/gjtorikian/html-proofer) to check for broken internal links. To test locally with HTMLProofer:
1. Build the site
```
bundle exec jekyll build
```
1. Get the parameters used for HTMLProofer in GitHub Actions here: [.github/workflows/ci.yml](.github/workflows/ci.yml)
1. 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:"
```