Skip to content

Commit

Permalink
docs: document using the docs (microsoft#591)
Browse files Browse the repository at this point in the history
  • Loading branch information
rwoll committed Jun 13, 2022
1 parent 90299f3 commit 26dd38b
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This website is built using [Docusaurus v2](https://v2.docusaurus.io/). Content
npm install
```

The project uses a fork of the [docusaurus-search-local](https://github.com/easyops-cn/docusaurus-search-local) plugin for search.
The project uses a fork of the [docusaurus-search-local](https://github.com/easyops-cn/docusaurus-search-local) plugin for search.

### Roll docs

Expand All @@ -27,11 +27,20 @@ node src/versions.js --delete 1.16
### Run dev server

```sh
npm run prepare-nodejs # or prepare-python, etc.
npm run start
```

Note that search indexes are only populated for prod build.

If you get an error like:

```
[ERROR] Error: Config file at "/…/microsoft/playwright.dev/docusaurus.config.js" not found.
```

be sure to run the relevant `npm run prepare-*` command! See `package.json` for targets.

### Run prod build and serve

```sh
Expand All @@ -41,7 +50,7 @@ npm run serve

### Running this on Windows

If you don't already, you might need to set the default shell to `bash`.
If you don't already, you might need to set the default shell to `bash`.

```powershell
npm config set script-shell "C:\\Program Files\\git\\bin\\bash.exe"
Expand All @@ -65,4 +74,4 @@ To roll the docs in PowerShell, make sure you set the env variable correctly, i.

```powershell
$env:SRC_DIR="C:\Users\user\src\playwright"; npm run roll
```
```

0 comments on commit 26dd38b

Please sign in to comment.