Package Exports
- @nurjs/readme-generator
- @nurjs/readme-generator/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@nurjs/readme-generator) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Readme generator
This project is used to generate documentation for stencil projects.
Usage
npx @nurjs/readme-generatorflags
| name | alias | description | type | default |
|---|---|---|---|---|
| clear | clears the console | boolean | false | |
| noClear | dont clears the console | boolean | false | |
| debug | prints debug messages | boolean | false | |
| version | prints version information | boolean | false | |
| referenceFolderPath | rf | path to reference folder | string | ./reference |
| projectName | p | Name of the project | ||
| project version | v | version of the project | string | |
| finalFileName | ff | Name of the final file | string | readme.md |
| baseReadmeFileName | bf | base readme file name | string | readme_base.md |
| projectPath | pp | path of the project | string | ./ |
| finalFilePath | ffp | path of the final file | string | ./ |