hardis:doc:project2markdown
Description
Generates a markdown documentation from a SFDX project
- Package.xml files
- Source Packages
- sfdx-hardis configuration
- Installed packages
Can work on any sfdx project, no need for it to be a sfdx-hardis flavored one.
Generated markdown files will be written in docs folder (except README.md where a link to doc index is added)
Parameters
| Name | Type | Description | Default | Required | Options |
|---|---|---|---|---|---|
| debug -d |
boolean | Activate debug mode (more logs) | |||
| flags-dir | option | undefined | |||
| json | boolean | Format output as json. | |||
| skipauth | boolean | Skip authentication check when a default username is required | |||
| websocket | option | Websocket host:port for VsCode SFDX Hardis UI integration |
Examples
$ sf hardis:doc:project2markdown