This is a sample repo for our testing (within SF/CCX teams)
This is still work in progress.
TODO
On the terminal, navigate to the doc-set repo (e.g., knowledge-center)
Till we are on mono-repo
- go to the parent folder (doc-framework-monorepo)
- To build content (to create htmls)
- salesforcedocs build packages/knowledge-center
- To validate content (to check whether the .md files are proper + linting + broken link checks)
- salesforcedocs validate packages/knowledge-center
- To run a local server (development mode - hot reload feature)
- salesforcedocs watch packages/knowledge-center
- To run as production server (Less logs + no hot reload + cached files)
- salesforcedocs start packages/knowledge-center
To preview your documentation site locally, goto http://localhost:3000
When you send a pull request to any of the protected branches, a remote build check gets triggered automaticaly. If the build for the content in your branch is successful, you will be notified of a preview enviornment on the GitHub PR page.