Skip to content

Commit 2a08160

Browse files
committed
add section on updating live site, add npm docs commands, fix typos
1 parent 399b4e0 commit 2a08160

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

docs/developers/documentation.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,22 @@ Run the command `poetry install` in the root directory of jsPsych to install `mk
1414

1515
## Building a local copy of the docs
1616

17-
Run `poetry run mike deploy [version] -u` to build a new version of the documentation or to override an existing version. For example, if you are testing an edit to version `7.2` of the documentation, run `poetry mike deploy 7.2 -u`.
17+
Run `poetry run mike deploy [version] -u` to build a new version of the documentation or to override an existing version. For example, if you are testing an edit to version `7.2` of the documentation, run `poetry run mike deploy 7.2 -u`.
18+
19+
You can also use jsPsych's custom npm command: `npm run docs:deploy [version]`, e.g. `npm run docs:deploy 7.2`.
1820

1921
This will build the documentation and commit it directly to the `gh-pages` branch.
2022

2123
We use [`mike`](https://github.com/jimporter/mike) instead of `mkdocs` for the build step to support versioning of the documentation. `mike` runs the `mkdocs` command under the hood.
2224

2325
## Viewing the local docs
2426

25-
Run `poetry run mike serve` to launch a local webserver. The docs will be viewable at `http://localhost:8000`.
27+
To launch a local webserver, run `poetry run mike serve`, or use jsPsych's custom npm command: `npm run docs:serve`.
28+
29+
The docs will be viewable at `http://localhost:8000`.
30+
31+
## Updating the public docs site
32+
33+
!!! warning "For core maintainers only"
34+
35+
After the documentation has been built locally (and therefore committed to your local `gh-pages` branch), you can update the live documentation site by switching to your `gh-pages` branch and pushing to the remote `gh-pages` branch.

0 commit comments

Comments
 (0)