Skip to content
A Jekyll site that provides a baseline for a documentation content site, conforming to the U.S. Web Design Standards.
JavaScript CSS HTML Ruby
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_includes
_layouts
_sass
_topics
assets
.gitignore
Gemfile
Gemfile.lock
LICENSE.md
README.md
_config.yml
feed.xml
index.html
topics.json

README.md

About This Project

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 Standards.

This project is help teams needing to make a documentation site get up and running faster. It provides a site that looks like this:

image

Using the Template

The site is built using Jekyll, a Ruby library for creating generating static sites. You will need Ruby to use this project.

Installation

[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 visit http://localhost:4000/ in your browser to preview the site.

Creating Content

[TO DO ADD INSTRUCTIONS ABOUT CREATING NEW CONTENT]

Configuration Options

[TO DO EXPLAIN WHAT CONFIGURATION OPTIONS NEED TO BE SET LIKE EMAIL AND GITHUB REPO AND GOOGLE ANALYTICS SNIPPIT]

We Want Your Feedback

We encourage your feedback and suggestions on these documents.

You can’t perform that action at this time.