Igniter.Scribe (igniter v0.6.11)

View Source

Contains functions for use with the --scribe option in Igniter.

See the guide for more.

Summary

Functions

Adds a new section to the documentation.

Sets the path and title of the document being generated. Only the first call to this is honored.

Functions

patch(original_igniter, callback)

section(igniter, header, explanation, callback)

Adds a new section to the documentation.

start_document(igniter, title, contents, opts \\ [])

Sets the path and title of the document being generated. Only the first call to this is honored.