Skip to content

Commit

Permalink
docs: add instructions for API docs (#5287)
Browse files Browse the repository at this point in the history
  • Loading branch information
mark-wiemer authored Jan 8, 2025
1 parent c5a0ef5 commit b720ec1
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ _So you wanna build the site?_
## Development

1. Run `npm install` / `npm ci` from working copy root to get Node.js deps.
1. To include the API documentation, run `npm run docs:api` before the either of the following commands.
1. To serve the site and rebuild as changes are made, execute `npm run docs-watch`.
1. To rebuild the site _once_, execute `npm run docs`.

Expand Down

0 comments on commit b720ec1

Please sign in to comment.