TIMS is using Jekyll and GitHub Pages for its static site: https://hot-ecosystem.github.io/tims/
- Edit files: What files to edit
- Depoy updates: Push/make a commit to the
gh-pagesbranch, and the update will automatmically be deployed.
Using on your local machine
The Docker Compose setup should allow you to run the Jekyll server locally (in Docker), edit files, and see the results with live reload.
- Run
docker compose upand wait until you seeServer running... press ctrl-c to stop. - Go to http://localhost:4000 in your browser.
- Open the page you want to edit in the browser and in your editor.
- Make changes, save, and you should see the results in your browser in a few seconds.
- The console where you ran
docker compse upshould show some logging. It might be useful if you're having issues. - Commit your changes and push to GitHub
- Changes should be visible on the GitHub Pages side once they're built and deployed. You can watch and confirm if the build and deployment succeeded here
CTRL+Cin the terminal should stop the Docker container.- No need to do a
docker compsoe downunless you need to start with a clean container, which takes time to do the initial setu. - Running
docker compse upthe next time to continue with the live reload should be much faster the next time.
- No need to do a
Initial setup
- Jekyll based: https://jekyllrb.com/docs/
- Server sepecific settings, which you can use in the docker-compose-yaml file, are here: https://jekyllrb.com/docs/configuration/options/#serve-command-options
- GitHub specifics: https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll
- Custom theme: https://mmistakes.github.io/minimal-mistakes/
Jekyll static site resources
Content can be added by following Jekyll's documentation and using the required markdown.
Jekyll uses Kramdown for markdown.
Additional devops resources