@@ -38,22 +38,40 @@ authors:
3838
3939MyST (Markedly Structured Text) is both:
4040
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
41+ * A language, which extends Markdown, for authoring technical documents, including
42+ executable code cells, ** and**
43+ * A software tool for executing and rendering technical documents from MyST source to
44+ multiple output formats including websites, PDFs, $ \LaTeX $, Typst, MS Word, JATS,
45+ and ` CITATION.cff ` .
4346
4447
45- ## Using MyST in JupyterLab
48+ ## Building a website
49+
50+ ### Building a MyST site in JupyterLab
4651
4752This JupyterLab instance has MyST installed, plus a special configuration for building
4853and exposing a MyST site at a special URL.
4954
50- To preview a MyST site, first...
55+ To preview a MyST site in JupyterLab, view instructions at [ ] ( ../../reference/04-using-myst.md ) .
56+
57+ :::{important} 👀 You should notice...
58+ :class: simple
59+ :icon: false
60+
61+ ...when you open the URL specified in the instructions above, a loading screen is
62+ displayed.
63+
64+ After a few seconds, the build will complete and you can see your fully-built site!
65+ :::
5166
52- ::::::{info} Using MyST on your local machine
67+ ::::::{note} Building a MyST site on your local machine
5368:class: dropdown
5469
55- The special configuration for building and hosting our MyST site is not necessary on a
56- local computer.
70+ It's important to us that you can take these skills home with you!
71+ Some things will be slightly different outside of JupyterLab.
72+
73+ The special configuration for building and hosting our MyST site in JupyterLab is not
74+ necessary on a local computer.
5775We even have some special features that we can't use in the JupyterLab environment,
5876for example a live-updating preview server:
5977
@@ -70,11 +88,27 @@ myst start
7088```
7189🔌 Server started on port 3000! 🥳 🎉
7290
73-
7491 👉 http://localhost:3000 👈
7592```
7693
7794At this point, you can visit the printed URL to preview your site.
7895The preview will automatically update any time you change a file.
7996:::
8097::::::
98+
99+
100+ ### Hosting your website for free
101+
102+ #### GitHub Pages
103+
104+ TODO
105+
106+
107+ #### ReadTheDocs
108+
109+ TODO
110+
111+
112+ ## Building a paper
113+
114+ TODO
0 commit comments