UAARG's website is hosted on GitHub Pages using the Jekyll as the content management tool.
If this is the first time you are working on this website, please familiarize yourself with the following technologies:
- HTML and CSS (Note: JavaScript is not used very much in this website.)
- Markdown
- Bootstrap CSS framework v4
- Jekyll
- Liquid Templating
Clone this repository to your local machine. Make sure you are using a UNIX system.
Install Ruby 2.3.1.
sudo apt install ruby
sudo apt install ruby-dev
Then install the required dependencies (Recommended to install as project specific rather than as global gems):
bundle config set path 'vendor/bundle'
bundle install
Why do we install dependencies in project workspace? - To prevent clutter in global configurations.
To serve a local version that you can use for testing:
bundle exec jekyll serve --watch --livereload
You can then open your web browser and preview the site by entering the server address
outputted by the serve command.
Note: In general, to run any installed packages, use:
bundle exec <Package-Command>
Some of the files and folders are directly served to clients. Others are pre-processed by Jekyll to generate the actual pages.
Below is a list of these special pre-processed files/directories.
_collection: Contains human readable content to be displayed in pages or cards.
_includes: Reusable website components that can be used anywhere.
_layouts: Acts as a "scaffolding" for all content pages.
assets: Contains images, CSS and JS files. Static assets.
vendor: Ruby dependencies.
Simply push to the master
branch and it should be built by github.
Simply edit the HTML files at the root of this repository. Note that the blog page is in a folder rather than HTML.
Member information can be found in the collections/_members
directory. Follow the format provided. There is also a format document in the google drive (May need to do digging to find it).
Go to _collections/_posts
and create a file in this format:
YEAR-MONTH-DAY-title.md
Then copy the front matter in past blogs and replace the information in them.
Write the content in markdown.
Thank you to all the developers who have worked on this website. Contact UAARG if you want your name added!
- Rijesh Augustine
- Cindy Xiao
- Ryan Sandoval
- Aditya Harvi
- Ricky Au
- Saahil Rachh
Copyright 2013 Kippt Inc. under The MIT License