How to contribute to the homepage
The homepage is built using Jekyll - a framework for building static webpages.
Installation instructions can be found here:
A step-by-step tutorial can be found here:
root: Contains the main HTML pages and configuration files.
_includes: Contains HTML fragments (ex. navbar, footer) that are repeatedly used across pages.
_layouts: Contains the HTML skeletons that the main content (ex. index.html, events.html) will be nested within.
_assets: Contains all project assets such as CSS, JS and images.
_site: Contains the compiled version of the homepage. (Not committed - will only show up locally after you build)
To test your code locally:
- Navigate to the root of the project
bundle exec jekyll serve
- This will build your code (which is saved under _site) and start a local server
- Open your browser and go to http://localhost:4000
Remote Container setup:
If don't want to install ruby locally, and you have Docker, you can use the VS Code Remote Container.
Just open the project with the Dev container and run
bundle exec jekyll serve -H 0.0.0.0.
(Please don't setup an EC2 instance just to work on this project)
.travis.yml: Contains the configuration for Travis CI
_config.yml: Contains the configuration for Jekyll
Gemfile: Lists all the ruby dependencies that the project needs (used for Jekyll)
deploy_rsa.enc: Encrypted key that travis uses to connect to deploy server.