doclite
Minimalist documentation generator
Last updated 2 years ago by r24y .
Original npm · Tarball · package.json
$ cnpm install doclite 
SYNC missed versions from official npm registry.

doclite

Minimal docsite generator.

npm

What does this do?

It turns your code into a website version, where comments are displayed nicely, and modules link to one another.

Basically, it turns this:

import express from 'express';

// Create the app
const app = express();

/* Set up the initial route */
app.get('/', function (req, res) {
  res.send('Hello World');
});

/* Start the server! */
app.listen(3000);

into this:

Above source code, with light syntax highlighting, and links

Getting started

npm install doclite
const Doclite = require('doclite');

Doclite.getTokens(`
// Code to document...
function foo() {
  return 1 + 2;
}
`);

API

Doclite.getTokens(src)

Returns an array of objects with the following properties:

  • value: Source text
  • start, end: Position in source
  • type: String identifying the token type

Current Tags

  • 0.0.0                                ...           latest (2 years ago)

1 Versions

  • 0.0.0                                ...           2 years ago
Maintainers (2)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 4
Dependencies (3)
Dev Dependencies (1)
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |