Skip to content

Commit ff311bb

Browse files
choldgrafrowanc1
andauthored
📖 Add npm verb to quickly demo docs (#2516)
Co-authored-by: Rowan Cockett <[email protected]>
1 parent fae1ab1 commit ff311bb

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

docs/developer.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -309,6 +309,14 @@ The build process uses unix commands that might not work properly on Windows.
309309
When building on Windows, use either WSL or a unix-like shell (such as Git Bash or MSYS2), and make sure that npm is set to use these by default (`npm config set script-shell path/to/shell.exe`).
310310
```
311311

312+
### Local docs workflows (preview/build)
313+
314+
To run a MyST server with your local changes and a preview of the documentation, run:
315+
316+
```shell
317+
$ npm run docs
318+
```
319+
312320
## Local development: myst-theme
313321

314322
The [`myst-theme` README](https://github.com/jupyter-book/myst-theme/) provides a more detailed overview of the components of that package.

package.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
"scripts": {
88
"build": "turbo run build",
99
"dev": "turbo run dev --parallel",
10+
"docs": "npm-run-all -l build --parallel dev docs:run",
11+
"docs:run": "cd docs && node ../packages/mystmd/dist/myst.cjs start",
1012
"clean": "turbo run clean --parallel && find . -name '.turbo' -type d -prune -exec rimraf '{}' +",
1113
"link": "turbo run link",
1214
"lint": "turbo run lint",

0 commit comments

Comments
 (0)