The DocSite

Introduction

Provides a framework for a minimal non-server-based documentation website that can be stored offline.

Table of Contents


How to Edit This Site

Headers and Footers

To change the headers and footers of the pages, you'll need to edit the ~/DocSite/Website/resources/scripts/docsite.js file. This JavaScript file uses JQuery to inject the appropriate HTML for a Bootstrap Navbar that collapses into a dropdown menu when viewed on small-screen devices.

You can change the links in the Navbar by editing the HTML added using the following command:

Success / Warning / Danger Cards

On the Example Page provided, you will see three cards displayed above the main text block. These are also added using a JQuery command in the ~/DocSite/Website/resources/scripts/docsite.js file. This command looks for a class attribute trigger value in the <body> tag, like this: <body class="success warning danger">, and adds the requested cards.

You can change what appears in the cards by editing the HTML added using the following commands:

Password / Important Notice Card

On the Example Page provided, you will also see one card displayed below the main text block, currently used to add a warning message about not including passwords in documentation. Again, this is added using a JQuery command in the ~/DocSite/Website/resources/scripts/docsite.js file. This command adds the card to every page in the site, unless there is a class attribute trigger value in the <body> tag, like this: <body class="intro">, indicating that this is an introductiory page.

You can change what appears in the card by editing the HTML added using the following command:


Contact the Developer

The DocSite was created by David Bailey from Bailey Web & Digital, and is released under an MIT Licence. The source code is available on GitHub.