The Org Documentor is a Salesforce CLI Plug-in that generates HTML documentation, styled with Bootstrap, from your local metadata. The original use case was to generate a data dictionary, but additional functionality has been added to include details of triggers and aura enabled classes.
The Org Documentor has a dedicated site that covers the configuration and more.
The following blog posts detail the progression of the Org Documentor:
- Documenting from the Metadata Source with a Salesforce CLI Plug-in - Part 1
- Documenting from the Metadata Source with a Salesforce CLI Plug-in - Part 2
- Documenting from the Metadata Source with a Salesforce CLI Plug-in - Part 3
- Documenting from the Metadata Source with a Salesforce CLI Plug-in - Part 4
- Documenting from the Metadata Source with a Salesforce CLI Plug-in - Part 5
- Documentor Plug-in - Triggers (and Bootstrap)
- Org Documentor and AuraEnabled Classes
- Org Documentor - Field Usage in Page Layouts
- Org Documentor - A Little More Configuration
- Org Documentor - Custom Header Colors
- Org Documentor - Flag Non-Display Fields
- Documenting the Documentor (and Moar Detail)
- Org Documentor - Field Count Badges
The plug-in source is available on Github at :
The plug-in is available for installation on NPMJS at :
An example metadata repo that shows up some of the features of the plug-in is
available on Github at :
And the output from running the plug-in on the example metadata can be viewed
on render at :
SO well valued job done.
ReplyDelete