|
2 | 2 |
|
3 | 3 | ## Previewing your MyST site |
4 | 4 |
|
5 | | -### First time |
| 5 | +### Building your site for the first time |
6 | 6 |
|
7 | | -To view your built site: |
| 7 | +Every MyST site must have a `myst.yml` config file that defines the project. |
8 | 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`. |
| 9 | +Right-click this file in the file browser and select the first item on the context menu: |
| 10 | +"Build MyST Project". |
16 | 11 |
|
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. |
19 | 14 |
|
20 | 15 |
|
21 | 16 | ### Subsequent builds |
22 | 17 |
|
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. |
25 | 20 |
|
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