Skip to content

Commit

Permalink
docs: README
Browse files Browse the repository at this point in the history
* indicate docs:install/build compatibility for docker only
  • Loading branch information
ciatph committed Sep 12, 2024
1 parent 8810f44 commit 36f16e5
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,10 +205,10 @@ Builds the class documentation into the **/docs** directory.
### `npm run docs:install`
Runs the Bash script that installs the JSDoc and theme dependencies for building the class documentation.
Runs the Bash script that installs the JSDoc and theme dependencies for building the class documentation within athe development Docker environment.
> [!NOTE]
> This script requires running from a Bash terminal: it won't work from a Windows command line terminal.
> This script requires running from a Bash terminal - it won't work from a Windows command line terminal. It is reserved for building the documentation with Docker.

This script is used for building the class documentation from a local Docker environment along with the `npm run docs:build` NPM script.

Expand All @@ -219,10 +219,10 @@ docker exec -u root -it ph-municipalities npm run docs:build

### `npm run docs:build`

Runs the Bash script that builds the class documentation using JSDoc.
Runs the Bash script that builds the class documentation using JSDoc within athe development Docker environment.

> [!NOTE]
> This script requires running from a Bash terminal: it won't work from a Windows command line terminal.
> This script requires running from a Bash terminal - it won't work from a Windows command line terminal. It is reserved for building the documentation with Docker.
This script is used for building the class documentation from a local Docker environment along with the `npm run docs:install` NPM script.
Expand Down

0 comments on commit 36f16e5

Please sign in to comment.