Tonic Site Generator

Automagic Site Generation

The Tonic Site Generator let you automate the generation of your Web Project site with comprehensive documentation.

User guides

Provide a way to organize and present to the user a set of guides.

API

Expose and describe the project library API

Source browsing

Expose the source code so it can be browsed by anyone online.

Getting Started

tonic-site-generator can be retrieved using npm.

npm

$ npm install tonic-site-generator --save

Quick-start

For the impatient, here's how to get boilerplate tonic-site-generator up and running.

$ git clone git@github.com:Kitware/tonic-site-generator.git
$ cd tonic-site-generator
$ npm install
$ npm test
# => Now browse to http://localhost:3000
# or to generate and view website documentation
$ npm run www:http
# => Now browse to http://localhost:3000

Documentation

See the documentation for a getting started guide, advanced documentation, and API descriptions.

Licensing

Tonic Site Generator is licensed under BSD 3 Clause Open Source License.

Getting Involved

Fork the tonic-site-generator repository and do great things. At Kitware, Inc., we want to make tonic-site-generator useful to as many people as possible.