Skip to content

Commit b330629

Browse files
committed
Init module 5 draft (WIP)
1 parent 0c8e33c commit b330629

File tree

1 file changed

+46
-0
lines changed
  • modules/05-sharing-and-publishing

1 file changed

+46
-0
lines changed

modules/05-sharing-and-publishing/index.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,49 @@ authors:
3232
webkitallowfullscreen="true">
3333
</iframe>
3434
:::
35+
36+
37+
## Technical publishing with MyST
38+
39+
MyST (Markedly Structured Text) is both:
40+
41+
* A language, which extends Markdown, for authoring technical documents, including executable code cells, **and**
42+
* A software tool for rendering technical documents from MyST source
43+
44+
45+
## Using MyST in JupyterLab
46+
47+
This JupyterLab instance has MyST installed, plus a special configuration for building
48+
and exposing a MyST site at a special URL.
49+
50+
To preview a MyST site, first...
51+
52+
::::::{info} Using MyST on your local machine
53+
:class: dropdown
54+
55+
The special configuration for building and hosting our MyST site is not necessary on a
56+
local computer.
57+
We even have some special features that we can't use in the JupyterLab environment,
58+
for example a live-updating preview server:
59+
60+
```bash
61+
myst start
62+
```
63+
64+
:::{important} 👀 You should notice...
65+
:class: simple
66+
:icon: false
67+
68+
...when the preview server successfully starts, the following message is printed:
69+
70+
```
71+
🔌 Server started on port 3000! 🥳 🎉
72+
73+
74+
👉 http://localhost:3000 👈
75+
```
76+
77+
At this point, you can visit the printed URL to preview your site.
78+
The preview will automatically update any time you change a file.
79+
:::
80+
::::::

0 commit comments

Comments
 (0)