@sfdocs-internal/cli

Salesforce Docs markdown framework

Usage no npm install needed!

<script type="module">
  import sfdocsInternalCli from 'https://cdn.skypack.dev/@sfdocs-internal/cli';
</script>

README

cli

Salesforce Docs Markdown Framework CLI

oclif Version Downloads/week

Usage

Commands

preview

TODO

validate

TODO

portal

Starts the portal server.

Portal sites are projects which know how to aggregate several writer asset repositories into a single site.

Note: Portal projects must define a docsportal.config.js[on] file to configure the portal

Flags

-d - Directory to operate on. Typically specified as the argument after the portal command sfdocs portal [directory]

-f - Force downloading of the content when starting the portal. By default, starting the portal will only download content if it has not already done so in the past.

--link-repo - When used in conjunction with --link-dir will specify which github repository should use local content instead of attempting to download it. Use this during development to work on the root repository.

--link-dir - When used in conjunction with --link-repo will specify the local file path to use instead of the remote github repository. Use this during development to work on the root repository.