Skip to content
Ronak Roy edited this page Jun 25, 2019 · 8 revisions

team3128.github.io Documentation

Welcome to the documentation for team3128.github.io, our team's website, built with Jekyll and hosted on Github Pages!

This documentation is divided into three levels: Basic, Intermediate, and Advanced.

Basic

These are most fundamental things you need to know to edit the website. This includes: setting up your computer to edit the website, editing content pages (like /about/, /members/, /contact/), editing list pages (i.e. /about/leaders/, /resources/, /sponsors/), adding blog posts, and an overview of the structure of files in our website.

Everyone should start here. The only prerequisites are knowing how to use computers, knowing how to save, edit, delete, and create files and folders, and speaking English.

Intermediate

These goes a little deeper, and requires a little more knowledge. This includes: creating/removing pages, adding/removing pages to the navigation bar or sidebars, and editing files/images.

This requires some prior knowledge of HTML and web design principles.

Advanced

Here's where things get messy. The website has a lot of details, and in order to learn about them, you'll have to peer into each of the individual parts. But, these docs will explain the workings of Jekyll and the specificities of our website (mainly custom HTML/CSS) so that you know where to look to find what.

At this level, you would be editing the layout of pages and the website as a whole, as well being able to edit the structure of the sponsors page, the sponsorship level chooser, the carousel on the homepage, and navigation dropdown menus.

This will require comfort/fluency in HTML, CSS, and JavaScript.