Class: Biscotto

Defined in: src/biscotto.coffee

Overview

Biscotto - the TomDoc-CoffeeScript API documentation generator

Class Method Summary

Class Method Details

@detectExtras(done)

Find extra project files in the repository.

@detectName(done)

Find the project name by either parsing package.json,

Parameters:

  • (Function) doneThe {Function} callback to call once this is done

@detectOrigin(done)

Find the project's Git remote.origin URL.

Parameters:

  • (Function) doneThe {Function} callback to call once this is done

@detectReadme(done)

Find the project's README.

@detectSources(done)

Find the source directories.

@detectTag(done)

Find the project's latest Git tag.

Parameters:

  • (Function) doneThe {Function} callback to call once this is done

@run(done, file, analytics = false, homepage = false)

Run the documentation generator. This is usually done through

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:

Parameters:

  • (Function) doneA {Function} to callback once the function is done
  • (Function) fileA {Function} to callback on every file
  • (String) analyticsA {String} representing Google analytics tracking code
  • (String) homepageThe {String} homepage in the breadcrumbs

String @script()

Get the Biscotto script content that is used in the webinterface

Returns:

  • (String) — Returns the script contents as a {String}.

String @style()

Get the Biscotto style content that is used in the webinterface

Returns:

  • (String) — Returns the style content as a {String}.

String @version()

Get the current Biscotto version

Returns:

  • (String) — Returns a {String} representing the Biscotto version