Skip to content

How to Install ApexDocs

Jump to bottom
Coding With The Force edited this page Aug 31, 2020 · 2 revisions

How to Run ApexDocs

  1. Install Node JS: Node JS Download

  2. Download my apex docs json config file and update the "root" path to the folder on your hard drive you would like you apex docs markdown files saved to: ApexDocs Config JSON

  3. Run the following command in Windows Powershell to install apexDocs: npm install -g @cparra/apexdocs

  4. In your CLI (whether in your IDE or via Powershell) to run apexDocs on your apex classes (can be further customized, documentation on this command on the ApexDocs github page): apexdocs-generate -s [Path to directory of apex files you would like documentation generated for] -c [path to the ApexDocsConfig.json file I provided for you] -p public private

More information about ApexDocs is located within its git repository here: ApexDocs

Clone this wiki locally