Skip to content

Latest commit

 

History

History
80 lines (52 loc) · 2.38 KB

README.md

File metadata and controls

80 lines (52 loc) · 2.38 KB
Raw

pupil-docs-website

Pupil docs static site generator.

Dependencies & Setup

  • hugo - static site generator written in Go
    • macOS: brew install hugo
    • Linux: sudo apt install hugo or snap install hugo
    • Windows: see hugo installation guide here
  • Pygments
    • pip install pygments or pip3 install pygments
  • Node and npm

Clone the repo and submodules:

git clone --recursive https://github.com/pupil-labs/pupil-docs-website.git

Install node dependencies

cd pupil-docs-website
npm install

Preview

Build and serve using gulp tasks. This will call hugo server as a child process after building all js and css.

gulp

By default this will serve on localhost:1313

Project structure

This project depends on 3 submodules:

  • content - contains all text and images used in documentation. It is versioned independently from the site generator and all styles. Versions of content are synchronized with versions of Pupil.
  • docuapi - a Hugo theme for slate with some nice custom tools. We forked the repo in order to make change to layouts and styles.
    • slate - a fork of Slate with only js, styles, and fonts stored for development. Javascript is minified and bundled with docuapi's custom GO bundler or with gulp task.

Diagram of the submodule hierarchy.

/pupil-docs-website
|-- content
|-- themes
|	`-- docuapi
|		`--static
|			`--slate

Deployment

Deployment with TravisCI. See .travis.yml and /scripts directory.

HTML Proofer

HTMLProofer - test rendered html files for errors

Have a look in Pupil Docs Wesite TravisCI logs for errors

What's Tested?

  • Images - img elements
  • Links - a, link elements
  • Scripts - script elements
  • HTML - Whether the HTML markup is valid. This is done via Nokogiri to ensure well-formed markup.

Installation

bundle install

Notes

Setup $GOPATH on Arch Linux SSL with letsencrypt - 3rd party tool