Welcome

This site demonstrates a prototype mobile-friendly Jekyll documentation theme based on bootstrap. The site uses no plugins and can be (is) automatically built by Github’s version of Jekyll.

Navigation is through a Table of Contents (TOC) sidebar, breadcrumb and navbar. The structure of these navigation elements is defined in data files, and can be automatically applied to articles based on their collection, parent folder, or in the page metadata. This allows multiple documentation sets to be built within a single site. The breadcrumb for the page is calculated from the TOC data structure.

The theme uses bootstrap-sass (bootstrap-sass-official v3.2.0+2 from bower). This provides access to all the standard bootstrap components and means that the site appearance can be radically changed using the normal bootstrap variables.

Currently the project is a prototype; it is full of debug information and it lacks features that a real site might need (SEO integration, analytics, feedback mechanisms, search). Developers are welcome to extend or fork the project on Github here.