Skip to content

Commit 7f4f813

Browse files
committed
Extract MyST build instructions to reference
1 parent 2865bb4 commit 7f4f813

File tree

2 files changed

+27
-20
lines changed

2 files changed

+27
-20
lines changed

for-instructors/dogfooding.md

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,7 @@ We have installed
2323
[`jupyter-myst-build-proxy`](https://github.com/ryanlovett/jupyter-myst-build-proxy)
2424
which builds the MyST site on-demand.
2525

26-
To view your built site:
27-
28-
* Copy the URL of your server (e.g. Matt's URL is
29-
`https://hub.cryointhecloud.com/user/mfisher87/lab`)
30-
* Open a new browser tab
31-
* Paste the URL in the URL bar
32-
* Replace `/lab` with `/myst-build/$DIRECTORY_OF_MYST_PROJECT`; for example, Matt's
33-
project is at `~/workshop-open-source-geospatial`, so his URL would be
34-
`https://hub.cryointhecloud.com/user/mfisher87/myst-build/workshop-open-source-geospatial`.
35-
36-
At this point you should see the build progress in your browser. It should only take a
37-
few seconds, and then you'll see your fully-built MyST site!
26+
See [](../reference/04-using-myst.md) for instructions.
3827

3928

4029
### Tradeoffs
@@ -44,14 +33,6 @@ start`
4433
([read more here](https://github.com/ryanlovett/jupyter-myst-build-proxy/issues/8)).
4534
As a consequence, builds are not triggered automatically when edits are performed.
4635

47-
Builds are triggered in two ways:
48-
49-
* First build: When the user first accesses the URL corresponding to the MyST project,
50-
and the built site is not found, a build is triggered.
51-
A nice UI shows the user progress in their browser during the build.
52-
* Subsequent builds: The user must append `/?rebuild=1` to the URL to trigger subsequent
53-
builds.
54-
5536
There is currently no known way to use the MyST preview server `myst start` in a
5637
JupyterLab environment. See https://github.com/jupyter-book/mystmd/issues/302
5738

reference/04-using-myst.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# 📝 Using MyST
2+
3+
## Previewing your MyST site
4+
5+
### First time
6+
7+
To view your built site:
8+
9+
* Copy the URL of your server (e.g. Matt's URL is
10+
`https://hub.cryointhecloud.com/user/mfisher87/lab`)
11+
* Open a new browser tab
12+
* Paste the URL in the URL bar
13+
* Replace `/lab` with `/myst-build/$DIRECTORY_OF_MYST_PROJECT`; for example, Matt's
14+
project is at `~/workshop-open-source-geospatial`, so his URL would be
15+
`https://hub.cryointhecloud.com/user/mfisher87/myst-build/workshop-open-source-geospatial`.
16+
17+
At this point you should see the build progress in your browser.
18+
It should only take a few seconds, and then you'll see your fully-built MyST site!
19+
20+
21+
### Subsequent builds
22+
23+
Your site will not automatically rebuild when you make changes!
24+
This functionality will be available in the future.
25+
26+
Append `/?rebuild=1` to the URL to trigger a rebuild.

0 commit comments

Comments
 (0)