2.1.0-alpha1 • Published 9 years ago

dev-documentation v2.1.0-alpha1

Weekly downloads
10
License
ISC
Repository
-
Last release
9 years ago

dev-documentation

A documentation-building server. Heavily inspired and partially copied from mattdesl's excellent budo project.

The core smarts are the documentation project, but this makes a workflow - a feedback loop of editing and previewing documentation - smooth and fast.

This will

  • run a server for you
  • automatically open http://localhost:8000/
  • automatically rebuild documentation when your code changes
  • automatically reload the page for you if you have LiveReload installed.

npm.io

Installation

This packages the documentationjs project, so it is installable with one command. You'll need nodejs installed.

$ npm install -g dev-documentation

Usage

For a single file

$ dev-documentation index.js

Or just run it in a project directory

$ cd my-project/
$ dev-documentation