Use command sfdx hardis:doc:plugin:generate to generate Github pages documentation #105
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi @mshanemc
Months ago during one of your developer community sessions, we discussed about the fact that default generated doc for SFDX plugins does not have the most optimal readability
I implemented a command to generate easier-to-browse documentation, applied it to sfdx-hardis, and I wanted to see if it would work on bigger plugins, so shane-sfdx-plugins seemed a good candidate
With a few updates (markdown header in main README), it works, so if you want you can
And everytime you'll publish a new version, doc will be automatically generated by a GitHub Actions CI job at https://mshanemc.github.io/shane-sfdx-plugins :) (cf screenshots)