Skip to content

Commit

Permalink
docs(contrib): Add mention of missing mkdocs dep (#4284)
Browse files Browse the repository at this point in the history
and additional mkdocs build line
  • Loading branch information
jeffreypriebe authored and develar committed Oct 22, 2019
1 parent b16a890 commit 4e73026
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ Documentation files located in the `/docs`.

`/docs` is deployed to Netlify when `next` release is marked as `latest` and available for all users.

`pip3 install mkdocs-material mkdocs pymdown-extensions pygments --upgrade`
`pip3 install mkdocs-material mkdocs markdown-include pymdown-extensions pygments --upgrade`

You'll want to copy the `mkdocs.yml` file from the master branch and then: `mkdocs build`

## Debug Tests

Expand All @@ -43,7 +45,7 @@ Or you can create Node.js run configuration manually:
```
* Set `Environment Variables`:
* Optionally, `TEST_APP_TMP_DIR` to some directory (e.g. `/tmp/electron-builder-test`) to inspect output if test uses temporary directory (only if `--match` is used). Specified directory will be used instead of random temporary directory and *cleared* on each run.

### Run Test using CLI
```sh
TEST_APP_TMP_DIR=/tmp/electron-builder-test ./node_modules/.bin/jest --env jest-environment-node-debug -t 'assisted' '/oneClickInstallerTest\.\w+$'
Expand Down

0 comments on commit 4e73026

Please sign in to comment.