Neolithic Populous Metropolis
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

codeine

0.0.2 • Public • Published

codeine

Generate documentaiton from JavaScript

CLI

To render a single page do

cat input.js | codeine [opts]

The output html wil be written to sdtout

To render a collection of files

codeine GLOB [*GLOB] [--dest DIR] [opts]

To create a server that re-generates on each request

codeine --server [--src DIR] [opts]

server options include server.port

API

var doc = require('codeine')

methods

doc(opts)

Returns a duplex stream

var generate = require('codeine').generate
`
/*
# noop
Does exactly what you might expect
*/
function noop() {
}
`.pipe(generate()).pipe(process.stdout)
 

install

npm install codeine

npm install -g codeine

license

MIT

Keywords

none

install

npm i codeine

Downloadsweekly downloads

3

version

0.0.2

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability