Skip to content

How to publish and run documentation locally ?

shraddha-kesari edited this page Sep 26, 2022 · 1 revision

To run docs in local

  1. Go to your feature branch
  2. Do npm install
  3. Run npm run docs:serve (this script is present in package.json)
  4. The Docs will be running. After the server says the script is finished. Hit localhost:3001, this will run in 3001 port.

To publish your docs:

  1. Raise PR and Merge your branch to master branch.
  2. Run npm run docs:deploy to publish your docs to production.

Amp documentation - prod