pug-doc-generator
Generates documentation files for pug.js mixins, blocks and more.
How to use
All mixins with comments starting with the @pugdoc markup will be documented. The documentation follows the JSDoc / TSDoc standards.
At the moment, the following tags are supported:
- @param
-
Normal typed parameters
@param {string} paramName Parameter description
-
Interface params:
@param {{ interfaceProperty: string }} interfaceParamName Interface parameter are also supported
-
Configuration
First of all, install it using your favorite package manager.
yarn install pug-doc-generator
or
npm i pug-doc-generator
Then, you can integrate it in your project:
src/index.pug
//- @pugdoc
This mixin will be documented
@param {string} param A string parameter
mixin documented_mixin(param)
="Hello world!"
index.js
const pugDocGen = require("pug-doc-generator");
pugDocGen({
input: "./src/**/*.pug",
output: "./out"
});
You can also run it via command line:
pug-doc-generator --input="./src/**/*.pug" --output="./out" --types="html"
or
yarn pug-doc-generator --input="./src/**/*.pug" --output="./out" --types="html"
For more information about command line parameters, run pug-doc-generator --help
4 May 3, 2022
14 Jan 3, 2023
7 Sep 1, 2022
15 Dec 26, 2022
92 Dec 26, 2022
6 May 14, 2022
20 Nov 29, 2022
41 Jan 4, 2023
103 Dec 30, 2022
2 May 11, 2022