FormidableLabs/docs-site-cli

Name: docs-site-cli

Owner: Formidable

Description: A CLI tool to generate a static documentation site for your project

Created: 2016-09-13 05:22:47.0

Updated: 2016-09-13 05:23:14.0

Pushed: 2016-09-19 16:25:26.0

Homepage: null

Size: 28

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

docs-site-cli

This CLI adds the scaffolding to an existing project to generate static docs sites.

Installation & Usage
m install -g docs-site-cli

 my-project
cs-site-cli new
cs-site-cli dev
cs-site-cli build
Commands
                creates new docs-site scaffolding
d               creates a build
                start the development server (no hot-loading yet)

--help          show usage information
--version       version number
Structure

The docs-site-cli cli will add these directories to your project. If they already exist, a warning will be thrown.

s
dex.md
ample-page.md
ample-page-2.md
s-site
omponents
dex.js
mplate.js

Default template:

der />
idebar alphabetical />
ontent>
{content}
Content>
oter>

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.