presidium-core

presidium-core

A Jekyll based technical software documentation framework

#presidium#bootswatch#sass#github-page#jekyll-site#documentation-tool#javascript#documentation-site
Demo Download
Branch Status
master
develop

Presidium

Presidium is a documentation framework that enforces industry best practices for documenting software systems. Presidium provides software teams with the tools to acquire, revise, categorize, utilize and evaluate small document fragments that get aggregated into a well structured static website. Presidium is based on familar tools already in use by many software development teams.

Quick Start

  • Download the template project
  • Requires ruby, bundler and npm. See setting up your environment for further details and requirements.
  • To install the required dependencies and start the documentation server locally, run:
    $ npm install
$ npm start

This will install all required dependencies and fire up a Jekyll server on: http://localhost:4000/

Add and edit your content following the examples in the content and media directories. Configure your site using the available options in _config.yml

Setup and Configuration

Directory Structure

Presidium is pre-configured with the following directories:

presidium/

    content/
        [section folders]/ : Folders with markdown content

    media/ : 
        css/ : Sass styling
        images/ : Image resources
        [other]/ : Static files
    
    dist/ : Distribution directory 
        src/: Presidium and Jekyll sources
        site/ : Generated static site
    
    .jekyll/ : Jekyll dependencies
        
    node_modules/ : node module dependencies, including the Presidium templates and structure
        
    _config.yml : Jekyll configuration file
    
    package.json : npm build scripts

Content

All content is stored in the content directory which is divided into sub-directories. Each sub-directory contains markdown templates that should be used to create documentation. See the template project for example usage. Presdium uses:

Other static content such as images, files, and custom styles should be added to the media directory.

Content and media resources are kept separate from the underlying Jekyll layouts and templates to allow for easy upgrades.

Build Scripts

The following build scripts manage the main workflow:

  • npm install : Installs all npm and Jekyll dependencies required to build, run and publish your site.
  • npm start : Serves the Jekyll site from dist/site and Watches for any changes to content and media.
  • npm run build : Build your Jekyll site to dist/site.
  • npm run gh-pages : Publishes dist/site to a gh-pages branch in your current repo.
  • npm run generate : Generate site structure and prepare Jekyll sources in dist/src.

Configuration

Site wide configuration, such as the site name and menu structure, can be updated in the _config.yml file. Changes made to this file require a site rebuild to take effect.

Styling and Theming

All styles are based on Bootstrap with Bootswatch themes and sass overrides. Jekyll themes are not supported.

To change a theme or to provide your own styling or overrides, make changes to:

  • _custom.scss : any custom styles that you would like to apply
  • _variables.scss : change the theme and override and bootstrap or bootswatch variables

Publishing to Github Pages

To publish your documentation to Github pages, run:

$ npm run gh-pages

This pushes your site and to a gh-pages branch on your repo. To enable your site on Github, go to your repository settings and enable Github pages using your gh-pages branch.

Further details may be found on Github

Setting up your Environment

Instructions are currently only available for OSX

The following tools are required to build and run Presidium locally:

  • OS: Mac OSX
    • npm > 3.10 : Node package manager to build, serve and publish
    • ruby > 2.1 : To build Jekyll site
    • bundler > 1.14.3 : To manage Jekyll dependencies

NPM

NPM

Install using the node package or nvm

  • node v6.10 (LTS)
  • npm v3.10

Ruby

Requires ruby >= 2.1

Newer versions are available via Homebrew:

$ brew install ruby

Bundler

Bundler is recommended to install Jekyll and its dependencies locally:

$ gem install bundler

For further details on setting up Jekyll for Github pages, see: Setting up github pages locally

Build Server

Provisioning a Debian Based build server:

The following script may be used to provision a build server to build a Jekyll site:

#!/bin/bash

sudo apt-get update
sudo apt-get install -y curl git

# Install Ruby
# http://rvm.io/rvm/install
gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3
\curl -sSL https://get.rvm.io | bash -s stable --ruby=2.4.0
source ~/.rvm/scripts/rvm
rvm install 2.4.0 --quiet-curl
rvm use 2.4.0 --default
ruby --version

# Install bundler
gem install bundler

# Install NPM
\curl -sL https://deb.nodesource.com/setup_6.x | sudo -E bash -
sudo apt-get install -y nodejs
minimalacademicresumeportfoliodocumentationwikitailwindbootstrapdarkecommercegithub-pagesblog