1.0.4 • Published 10 years ago

fishdoc v1.0.4

Weekly downloads
2
License
GPL-3
Repository
github
Last release
10 years ago

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

1.0.4

10 years ago

1.0.3

10 years ago

1.0.2

10 years ago

1.0.1

10 years ago

1.0.0

10 years ago