🔨 Add specific notes here about content style guides or how contributors can work together to update content on your site.
How to build this website locallyIn production (GitHub Actions), environment is setup by workflows in .github/workflows/.
Use VS Code and the Dev Containers extension, install a Docker host (on Mac, use OrbStack) then run VS Code command "Reopen in Container".
Or if you do not want VS Code or the Docker setup, install your environment manually:
Install Ruby (use version in build-test-deploy.yml in "Setup Ruby", (try rbenv)
Install Jekyll:
gem update --system gem install bundler bundle install
Install Node & yarn, use version in build-test-deploy.yml in "Setup Node.js", (try nvm):
nvm install --lts --reinstall-packages-from=current nvm use --lts yarn install
Build the HTML website.
Access your site at http://127.0.0.1:4000 (or see other "server address" in console output).
bundle exec jekyll serve --livereload
Perform code linting (this does not require building the site):
And automatically fix with:
Perform website testing (you must have already built the site)
Open this folder in VS Code, allow the "Reopen in Container" and install recommended extensions.
This will give you formatting, linting, and other tools to help you develop.
Maintenance: updating dependenciesDo this every month or so and please send a PR here if you see updates available:
yarn set version latest && yarn # Send PR yarn upgrade-interactive # Send PR
Also you can run this to update your environment to match the GitHub Pages (no PR, this is in .gitignore):
bundle update --conservative # "--consersative" ignores updates that GitHub Pages is not using
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4