Skip to content

Commit 3bf57dc

Browse files
authored
Update MyST reference instructions to use new UX (#43)
* Update MyST reference instructions to use new UX Instead of URL editing, the user will have features in the user interface to enable them to build and rebuild their MyST site. This is a compromise, not our end goal; we want the skills they use in the JupyterLab environment to be low-frication _and_ portable to their local machine. I.e. we want them to use `myst start`. This is currently not possible, and the MyST team expects it may take a month or more. * Fix header level
1 parent 580d168 commit 3bf57dc

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed

reference/04-using-myst.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,29 @@
22

33
## Previewing your MyST site
44

5-
### First time
5+
### Building your site for the first time
66

7-
To view your built site:
7+
Every MyST site must have a `myst.yml` config file that defines the project.
88

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`.
9+
Right-click this file in the file browser and select the first item on the context menu:
10+
"Build MyST Project".
1611

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!
12+
A new tab will open displaying a loading progress indicator.
13+
After a few seconds, your site will be built and you'll it displayed in the current tab.
1914

2015

2116
### Subsequent builds
2217

23-
Your site will not automatically rebuild when you make changes!
24-
This functionality will be available in the future.
18+
In JupyterLab, your site will **not** automatically rebuild when you make changes!
19+
This functionality will be available in JupyterLab the future.
2520

26-
Append `/?rebuild=1` to the URL to trigger a rebuild.
21+
For now, the JupyterLab infrastructure will magically add a "Rebuild" button to the
22+
top-right of your site, which you can click to trigger a new build of your site.
23+
24+
Do this every time you make a change to see if it worked correctly!
25+
26+
27+
### How this works
28+
29+
This functionality is provided by the extension
30+
[`jupyter-myst-build-proxy`](https://github.com/ryanlovett/jupyter-myst-build-proxy/).

0 commit comments

Comments
 (0)