Skip to content

Commit f878a5f

Browse files
mfisher87maxrjones
andauthored
Module 5 adjustments from Fernando feedback (#75)
Co-authored-by: Max Jones <[email protected]>
1 parent 09dfb40 commit f878a5f

File tree

2 files changed

+21
-6
lines changed

2 files changed

+21
-6
lines changed
91.9 KB
Loading

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

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@ MyST (Markedly Structured Text) is both a language and a software tool.
4141

4242
### MyST, the language
4343

44-
MyST, as a language, extends Markdown.
44+
MyST, as a language, is a flavor or dialect of Markdown optimized for technical
45+
publishing.
4546

4647
It adds new syntax, including
4748
["roles" and "directives"](https://mystmd.org/guide/quickstart-myst-markdown#directives-and-roles)
@@ -285,6 +286,11 @@ Hello, world!
285286
$$
286287
1 + 1 = 2
287288
$$
289+
290+
:::{note} Click Me! 👈
291+
:class: dropdown
292+
👋 Wow! MyST is fun and cool!
293+
:::
288294
```
289295

290296
The `$$` symbols delimit a math equation, and you can write any $ \LaTeX $ within.
@@ -622,8 +628,8 @@ More information is available on the
622628
* MyST documents can be built to multiple output formats, including PDFs.
623629
* Frontmatter is YAML metadata on a Markdown document that can tell MyST which documents
624630
should be built as PDF.
625-
* [Typst](https://typst.app/) can be used as an alternative document engine to
626-
$ \LaTeX $ for rendering PDFs by specifying `export.format: "typst"` in the frontmatter.
631+
* [Typst](https://typst.app/) can be used to render PDFs by specifying `export.format:
632+
"typst"` in the frontmatter. $ \LaTeX $ is also an available option!
627633
* If you opened the collapsed section on quoting YAML, you know the author of this
628634
document has been burned too many times. **Quote your strings**! 😁
629635
@@ -640,7 +646,9 @@ GitHub Pages is, as it sounds, a GitHub-native solution for hosting web pages.
640646
It doesn't offer any advanced features, it only enables building a website from a GitHub
641647
repository.
642648
643-
Pages are built using [GitHub Actions](https://github.com/features/actions).
649+
Pages are built using [GitHub Actions](https://github.com/features/actions), a tool for
650+
triggering processes automatically in response to changes or other events in a GitHub
651+
repository.
644652
645653
646654
### [ReadTheDocs](https://about.readthedocs.com/)
@@ -726,8 +734,15 @@ PDF.
726734
When you download your PDF, it looks exactly like the PDF you built manually earlier!
727735
:::
728736

729-
If your deploy failed, click the "deploy" node to view the error logs.
730-
See if you can solve the error on your own, and let an instructor know if you need help!
737+
:::{attention} My "deploy" Action failed!
738+
:class: dropdown
739+
740+
![](./github-actions-deploy-failed.jpg)
741+
742+
If your deploy Action failed, click the "deploy" node to view the error logs.
743+
See if you can decipher the error message and solve the problem on your own, and let an
744+
instructor know if you need help!
745+
:::
731746

732747

733748
#### Display your GitHub Pages URL on your repository homepage

0 commit comments

Comments
 (0)