Building and previewing docs
Prerequisites
Installation & running
Step 1: navigate to main docs directory in cmd / powershell
Step 2: fetch modules
yarn
npm install
- Step 3: run docs in development mode
yarn docs:dev
npm run docs:dev
- Step 3: While above command is running you can navigate to http://localhost:8080/ (port may be different) to see local docs page.
Any edits to local markdown files inside /docs/docs
directory will be reflected on page within few seconds.
Any configuration changes require docs restart to fully take effect.