Class Biscotto
Defined in: | src/biscotto.coffee |
Overview
Class Method Summary
- .detectExtras(done) Find extra project files in the repository.
-
.detectName(done)
Find the project name by either parsing
package.json
, or getting the current working directory name. - .detectOrigin(done) Find the project's Git remote.origin URL.
- .detectReadme(done) Find the project's README.
- .detectSources(done) Find the source directories.
- .detectTag(done) Find the project's latest Git tag.
- .generateMetadataSlug(packageJsonPath, parser, options) Builds and writes to metadata.json
- .populateSlug(slug, filename, ) Parse and collect metadata slugs
- .run(done, file_generator_cb, analytics = false, homepage = false) Run the documentation generator.
- String .script() Get the Biscotto script content that is used in the webinterface
- String .style() Get the Biscotto style content that is used in the webinterface
- String .version() Get the current Biscotto version
Class Method Details
.detectExtras(done) Source
.detectName(done) Source
.detectOrigin(done) Source
.detectReadme(done) Source
.detectSources(done) Source
.detectTag(done) Source
.generateMetadataSlug(packageJsonPath, parser, options) Source
.populateSlug(slug, filename, ) Source
.run(done, file_generator_cb, analytics = false, homepage = false) Source
Examples:
biscotto = require 'biscotto'
file_generator_cb = (filename, content) ->
console.log "New file %s with content %s", filename, content
done = (err) ->
if err
console.log "Cannot generate documentation:", err
else
console.log "Documentation generated"
biscotto.run done, file_generator_cb
String .script() Source