Link Search Menu Expand Document

GitHub Pages

GitHub Pages is an incredibly handy tool that allows you to host websites directly from your GitHub repositories. This allows for you to keep your software documentation and instruction manuals directly with the source code, all version controlled.

Additionally, GitHub Pages is powered by Jekyll and Kramdown which means that you can write almost everything you need for your website in simple markdown instead of having to fool around with writing convoluted HTML.

To learn more about GitHub Pages, see the video below.

Getting Started

To get started with GitHub Pages, it’s recommended that you first look at the Getting Started page. You’ll learn how to set up your first GitHub Pages site there.

After you have done this, it’s recommended to check out the Best Practices and the page on building locally.

Building Your Website Locally

To accelerate the development of your GitHub Pages website, it is recommended to install the dependencies necessary to build the site locally (on your machine) and not rely on GitHub to build the website for you during the prototyping phase, as it can be a lengthy process. We have included a guide on how to do this at this link.


Table of contents