fishdoc
Markdown documentation builder
Last updated 4 years ago by litarvan .
GPL-3 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install fishdoc 
SYNC missed versions from official npm registry.

Fishdoc

The markdown documentation builder

To use fishdoc, create a nodejs project with 'fishdoc' as dependency, and then you can do like this :

var fishdoc = require('fishdoc');

fishdoc
({
    path: 'docs',
    output: 'build',
    name: 'Grass',
    link: 'https://github.com/Grass/',
    // logo: 'logo.png', // Optional, to replace the logo in the navbar
    clean: true, // Optional, to clean the output directory (by default, set to false),
    // template: 'assets/template.html', // Optional, to replace the template (discouraged)
    colors: // Optional, to change the template colors
    {
        nav: 'green',
        navText: 'white',
        navHover: 'rgba(0, 0, 0, 0.15)',
        tree: '#151515',
        treeText: 'white',
        treeHover: 'rgba(0, 74, 4, 0.30)'
    }
});


It will generate the documentation in the 'build' folder from the 'docs' folder

Current Tags

  • 1.0.4                                ...           latest (4 years ago)

4 Versions

  • 1.0.4                                ...           4 years ago
  • 1.0.3                                ...           4 years ago
  • 1.0.2                                ...           4 years ago
  • 1.0.0                                ...           4 years ago
Maintainers (1)
Downloads
Today 0
This Week 1
This Month 1
Last Day 0
Last Week 0
Last Month 8
Dependencies (4)
Dev Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |