This is a template website built to provide a baseline for documentation content such as "how-to" guides, technical manuals, and the like. It is built to conform to the U.S. Web Design System.
This project is help teams needing to make a documentation site get up and running faster. It provides a site that looks like this:
The site is built using Jekyll, a Ruby library for creating generating static sites. You will need Ruby to use this project.
[to do write installation guide]
- Install ruby
- Install Jekyll
- Download the project from github (or fork it?)
- To run the site locally, run
jekyll serve --watch, then visithttp://localhost:4000/in your browser to preview the site.
[TO DO ADD INSTRUCTIONS ABOUT CREATING NEW CONTENT]
[TO DO EXPLAIN WHAT CONFIGURATION OPTIONS NEED TO BE SET LIKE EMAIL AND GITHUB REPO AND GOOGLE ANALYTICS SNIPPIT]
We encourage your feedback and suggestions on these documents.