Skip to content

How do you use this? #1

Description

@trusktr

dgeni-alive is a documentation generator and there are no... docs?

Why not use dgeni-alive to generate some?

The example

var docgen = require('../scr/docgen')(); // src is spelled wrong.
docgen.package().config(function(log) { // package should be Package
    log.level = 'info';
})
.src(/* what the heck goes here? */);
.dest(/* a directory pathI assume? */);
.generate() // generates the HTML output I suppose.
.then(function(/* any parameters here? */){
  console.log("I'm done!");
});

doesn't really explain anything.

Please, can you document dgeni-alive and how to use it by itself (no grunt).

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions