Skip to content

Commit 4f8a5f9

Browse files
r-fordbrian-rosepre-commit-ci[bot]
authored
Update Markdown page with links (#642)
* Test edit * Update md tutorial * Update foundations/markdown.md Co-authored-by: Brian Rose <brose@albany.edu> * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Apply suggestions from code review Co-authored-by: Brian Rose <brose@albany.edu> * Add Markdown to glossary --------- Co-authored-by: Brian Rose <brose@albany.edu> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent e362e3f commit 4f8a5f9

2 files changed

Lines changed: 10 additions & 5 deletions

File tree

appendix/glossary.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,9 @@ Linux
8888
local
8989
: Refering to something, such as a {term}`Git` repository, on your computer rather than a remote server.
9090

91+
Markdown
92+
: A simple, human-readable text language used extensively in {term}`Jupyter Notebooks`, on {term}`GitHub` and other code repositories, and elsewhere on the Internet (e.g., forums and blogs). Markdown lets us write readable plain text that can rendered as nicely styled text on web pages and other media, with headings, links, and other formatting.
93+
9194
merge
9295
: A specific type of commit that combines changes from two branches.
9396

foundations/markdown.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# Formatted Text in the Notebook with Markdown
22

3-
```{note}
4-
This content is under construction!
5-
```
3+
{term}`Markdown` is a simple, human-readable text language used extensively in {term}`Jupyter Notebooks`, on {term}`GitHub` and other code repositories, and elsewhere on the Internet (e.g., forums and blogs). Markdown lets us write readable plain text that can rendered as nicely styled text on web pages and other media, with headings, links, and other formatting.
64

7-
This section will give a tutorial on formatting text with Markdown: the simple, human-readable text language used extensively in Jupyter notebooks, GitHub Discussions, and elsewhere.
5+
Project Pythia uses [MyST Markdown](https://mystmd.org/), which is an extension of [CommonMark](https://commonmark.org/), which is in turn an implementation of [Markdown](wiki:Markdown).
6+
In fact, the page you are reading right now was written in Markdown! See the [source on GitHub here](https://github.com/ProjectPythia/pythia-foundations/blob/main/foundations/markdown.md).
87

9-
We will show how this is useful both in notebooks and other places like GitHub Issues.
8+
Markdown was briefly mentioned in the previous section in the context of {term}`Jupyter Notebooks`. Here we provide a list of recommended resources for learning more.
9+
- To learn the basics: the [CommonMark docs](https://commonmark.org/help/), including their [10-minute interactive tutorial](https://commonmark.org/help/tutorial/)
10+
- To learn some of the MyST-specific syntax: the [Introduction to MyST Markdown page](https://jupyterbook.org/stable/authoring/mystmd/) within the Jupyter Book User Guide
11+
- To learn everything that you can do with MyST: the [Authoring section of the MyST guide](https://mystmd.org/guide/typography)

0 commit comments

Comments
 (0)