Skip to content

hardis:doc:plugin:generate

Description

Generate Markdown documentation ready for HTML conversion with mkdocs

After the first run, you need to update manually:

  • mkdocs.yml
  • .github/workflows/build-deploy-docs.yml
  • docs/javascripts/gtag.js , if you want Google Analytics tracking

Then, activate Github pages, with "gh_pages" as target branch

At each merge into master/main branch, the GitHub Action build-deploy-docs will rebuild documentation and publish it in GitHub pages

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:plugin:generate