hardis:doc:mkdocs-to-salesforce
Description
Generates MkDocs HTML pages and upload them to Salesforce as a static resource
This command performs the following operations:
- Generates MkDocs HTML pages (using locally installed mkdocs-material, or using mkdocs docker image)
- Creates a Static Resource, a VisualForce page and a Custom Tab metadata
- Upload the metadatas to the default org
- Opens the Custom Tab in the default browser (only if not in CI context)
Note: the documentation must have been previously generated using "sf hardis:doc:project2markdown --with-history"
You can:
- Specify the type of documentation to generate (CICD or Monitoring) using the --type flag. Default is CICD.
- Override default styles by customizing mkdocs.yml
More info on Documentation section
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 | |||
| target-org -o |
option | undefined | |||
| type -t |
option | Type of the documentation to generate. Default is "all" | CICD | CICD Monitoring |
|
| websocket | option | Websocket host:port for VsCode SFDX Hardis UI integration |
Examples
$ sf hardis:doc:mkdocs-to-salesforce