megadoc

Plugins

Developers

RendererUtils

normalizeHeading

TestHelpers

TestUtils

IntegrationSuite

UI

MetaDescriptionManager

[General]

megadoc Function

Defined in: lib/index.js

Perform a megadoc compilation.

Signature

megadoc(userConfig: Config, runOptions: Object) -> Object

Parameters (2)

`userConfig`	`Config`
`runOptions`	`Object` The options to pass to Compiler#run.

Return Values

`rc`	`Object`
`rc.config`	`Object`
`rc.compiler`	`Compiler`
`rc.run`	`Function`

Made with ♥ using megadoc.