Skip to content

Commit

Permalink
Update commands needed to build docs
Browse files Browse the repository at this point in the history
  • Loading branch information
asbjornu committed Dec 29, 2023
1 parent f5ada0e commit 8746750
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,28 +17,35 @@ expected.

## Serving the documentation locally

To serve up the documentation locally, you need to run the script
To serve up the documentation locally, you need to run the following
commands:

```shell
./build.ps1 -Stage build -Target PrepareBuild
./build.ps1 -Stage build -Target Build
./build.ps1 -Stage docs -Target PreviewDocs
```

### On Windows

On Windows, you need to run the following build command in a PowerShell
On Windows, you need to run the following commands in a PowerShell
terminal:

```shell
./build.ps1 -Stage build -Target PrepareBuild
./build.ps1 -Stage build -Target Build
./build.ps1 -Stage docs -Target PreviewDocs
```

### On Unix

First you need to [install PowerShell on macOS][ps-mac] or [Linux][ps-linux],
then execute the following command:
then execute the following commands:

```shell
pwsh ./build.ps1 -Stage docs -Target PreviewDocs
./build.ps1 -Stage build -Target PrepareBuild
./build.ps1 -Stage build -Target Build
./build.ps1 -Stage docs -Target PreviewDocs
```

After pressing enter, the documentation will be generated and then served under
Expand Down

0 comments on commit 8746750

Please sign in to comment.