DruxtDocgen
DruxtDocgen
DruxtDocgen class.
Kind: global class
.generateDocs()
Generate documentation for source JS and Vue files.
Kind: instance method of DruxtDocgen
.copyFiles()
Copy external files to the generated files.
Kind: instance method of DruxtDocgen
.generateApiDocs()
Generate API documents.
Kind: instance method of DruxtDocgen
.generateComponentsList()
Generate list of components.
Kind: instance method of DruxtDocgen
.generateModuleReadmes()
Generate pages under modules/<package>/readme from each public
package's README, so the site mirrors the npm README without drift.
Emitted as readme/index.md (rather than readme.md) so the file
cannot collide with the hand-maintained README.md on
case-insensitive filesystems.
Kind: instance method of DruxtDocgen
.generatePackageList()
Generate list of packages.
Kind: instance method of DruxtDocgen
.processJs(file, templateData)
Process Javascript files.
Kind: instance method of DruxtDocgen
| Param | Type | Description |
|---|---|---|
| file | string | The source file path. |
| templateData | Array.<object> | The JSDoc generated template data. |
.processVue(file, templateData)
Process Vue.js files.
Kind: instance method of DruxtDocgen
| Param | Type | Description |
|---|---|---|
| file | string | The source file path. |
| templateData | Array.<object> | The JSDoc generated template data. |
.writeTemplateData(file, templateData)
Write template data to file system.
Kind: instance method of DruxtDocgen
| Param | Type | Description |
|---|---|---|
| file | string | The file name. |
| templateData | Array.<object> | The JSDoc / Vuedoc generated data. |