Skip to content

Commit d15f3fb

Browse files
committed
Fill out docus for bit-docs.js
1 parent 9cf561e commit d15f3fb

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

bit-docs.js

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,31 @@ var mergeOnto = function(prop, dest, source){
1414
* @group bit-docs-generate-html/modules modules
1515
* @group bit-docs-generate-html/static static
1616
* @group bit-docs-generate-html/templates templates
17+
* @group bit-docs-generate-html/generated generated
1718
* @group bit-docs-generate-html/types types
1819
*
19-
* @description Generates HTML for a docMap. Supports plugins.
20+
* @description Generates HTML for a docMap and handles the `html` hook.
2021
*
2122
* @body
2223
*
23-
* TBD
24+
* This plugin registers onto these hooks:
25+
* - `tags`
26+
* - `generator`
27+
*
28+
* Registering the `tags` hook adds the `@templaterender` tag.
29+
*
30+
* Registering the `generator` hook makes it so this plugin can generate the
31+
* HTML output from the provided [bit-docs/types/docMap]. The entry point for
32+
* this generator is [bit-docs-generate-html/html].
33+
*
34+
* This plugin handles the `html` hook, which allows other plugins to hook into
35+
* the generation process, to do things like include their own static assets,
36+
* or provide their own mustache templates.
37+
*
38+
* This plugin provides a default set of mustache templates and static assets.
39+
* These mustache templates and less styles can be copied over into a theme
40+
* plugin and customized. Any custom mustache template will override a default
41+
* of the same name.
2442
*/
2543
module.exports = function(bitDocs){
2644
bitDocs.register("generator", generator);

0 commit comments

Comments
 (0)