ABOUT

SfDoc was created to simplify process of documentation creation. It is based on NodeJs.

Idea is to: 1. generate .md files for first run 2. generate ./docs directory

.md files should be populated manually after development of specific task is done
.md files guide: https://www.markdownguide.org/basic-syntax/

USAGE

Configuration: docsify cli is required (https://docsify.js.org/#/quickstart)

To initialize .md files:

sfdocs
--init
--sfdir 'C:XXXXXXX\sf_sample\force-app\main\default'

To generate docs:

sfdocs
--sfdir 'C:XXXXXXX\sf_sample\force-app\main\default'

Options:
--help Show help [boolean]
--version Show version number [boolean]
--init Creates initial documentaton files in salesforce project structure. Specify along with sfdir argument [boolean] --sfdir Directory contains sfdx project. Should point to single project [string] [required]
--docsdir Directory containing base docsify files [string] [default: "./docs/"]

To open generated documentation use docsify serve command:

docsify serve docs

CREDIT

Created by Sebastian Gozdur (Salesforce Developer)

Contact via Github or https://www.linkedin.com/in/sebastian-gozdur/