This site is designed with future users in mind, so the group chose platforms that would be accessible to a wide range of users: Jekyll and GitHub Pages.
More details are available in the GitHub wiki.
Jekyll is a Ruby gem that generates static websites from markdown, HTML, and other formats. See the official Jekyll documentation for details.
Steps for contributing have been documented in the wiki on the 2016 site's GitHub page and will be updated as needed.
See a list of open issues. The following example uses "issue#3" as a subject. That's the branch name and is used in the commit message.
git clonethe repo from GitHub- cd to repo root and
git pull bundle install- Continue with step 3 below
- Make sure you're on the main branch
git checkout main
- Make sure your main branch is up to date
git pull origin main
- Start up jekyll
bundle exec jekyll serve- open http://localhost:4000 in your browser
- Create a new branch for your changes
git checkout -b issue#3
- Make changes, check http://localhost:4000 to see your changes live
- We strongly recommend performing an accessibility audit (e.g. with Chrome) if you've made structural or stylistic changes (not adding text content or additional posts)
- Add your changed files
git add {changed-files}
- Commit your changes with a fancy message
git commit -m "fixes issue #3"
- Add your branch to the repo
git push --set-upstream origin issue#3
- Switch back to the main branch
git checkout main
- Go to https://github.com/code4lib/2025.code4lib.org
- Make a pull request base:main and compare:issue-3
- Wait for someone to test your changes and merge the pull request
- Do the dance of joy 🎉
- Follow steps 1 - 3 above
- Get any remote branches
git fetch
- Switch to the branch in question
git checkout BRANCHNAME
bundle exec jekyll serve- Check http://localhost:4000 that nothing is broken
- Merge that branch into main (easiest to manage on the GitHub site)