# tonic-site-generator

**Repository Path**: mirrors_Kitware/tonic-site-generator

## Basic Information

- **Project Name**: tonic-site-generator
- **Description**: Web site generator for Web project relying on Jekyll, mdoc and docco. This project is used within the Tonic suite to create consistent Web pages and documentation.
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-09
- **Last Updated**: 2026-03-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## tonic-site-generator

### Web site generator for Web projects

**tonic-site-generator** is a JavaScript command line tool that let you generate
and build a complete project web site with its documentation.

#### Getting Started

**tonic-site-generator** can be retrieved using **npm**. 

##### npm

```bash
$ npm install -g tonic-site-generator
```

##### From the project

You can try it by running 

```bash
$ git clone git@github.com:Kitware/tonic-site-generator.git
$ cd tonic-site-generator
$ npm install 
$ npm run test:basic
$ open http://localhost:3000
```

#### Documentation

See the [documentation](https://kitware.github.io/tonic-site-generator) for a
getting started guide, advanced documentation, and API descriptions.

#### Licensing

**tonic-site-generator** is licensed under [BSD Clause 3](LICENSE).

#### Getting Involved

Fork our repository and do great things. At [Kitware](http://www.kitware.com),
we've been contributing to open-source software for 15 years and counting, and
want to make **tonic-site-generator** useful to as many people as possible.