barricadeio / docs

Barricade Docs

Barricade Docs

docs.barricade.io, built as a static site with Hugo.

--

New content is added by adding Markdown files to the /content subdirectories. New images and other media should be located in themes/barricade/static/src.

--

Local Development

The user manual for Barricade is built with Hugo, the API docs with Middleman.

• Run hugo server --watch to generate the site
• Run bundle exec middleman build --clean in api directory
• In a different window, run gulp watch to compile assets
• The site will be available at localhost:1313

Deploying

Master is automatically deployed to Github Pages via CircleCI.

API Doc

API doc is generated by Slate. We build API doc under a Hugo target directory so that it gets picked up by Hugo.