Class: Biscotto
Defined in: | src/biscotto.coffee |
Overview
Biscotto - the TomDoc-CoffeeScript API documentation generator
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.
- .run(done, file, 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
Find extra project files in the repository.
.detectName(done) Source
Find the project name by either parsing package.json
, or getting the current working directory name.
.detectOrigin(done) Source
Find the project's Git remote.origin URL.
.detectReadme(done) Source
Find the project's README.
.detectSources(done) Source
Find the source directories.
.detectTag(done) Source
Find the project's latest Git tag.
.run(done, file, analytics = false, homepage = false) Source
Run the documentation generator. This is usually done through the command line utility biscotto
that is provided by this package.
This function sets up all of the configuration options used by Biscotto.
You can also run the documentation generation without writing files to the file system, by supplying a callback function.
Examples:
String .script() Source
Get the Biscotto script content that is used in the webinterface
String .style() Source
Get the Biscotto style content that is used in the webinterface
String .version() Source
Get the current Biscotto version