0.0.3 • Published 1 year ago
@nurjs/readme-generator v0.0.3
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 | ./ |