From 03735f63caa24fc9a543a75c4fa9bff4a108ad7b Mon Sep 17 00:00:00 2001 From: Robert Ford <50349951+r-ford@users.noreply.github.com> Date: Tue, 28 Apr 2026 13:45:24 -0400 Subject: [PATCH 1/6] Test edit --- preamble/how-to-use.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/preamble/how-to-use.md b/preamble/how-to-use.md index baad01226f..b99910d002 100644 --- a/preamble/how-to-use.md +++ b/preamble/how-to-use.md @@ -2,7 +2,15 @@ ## Overview -Pythia Foundations is a geoscience-flavored introduction to essential tools in the Scientific Python Ecosystem (SPE) and [Pangeo](https://pangeo.io) stack. It covers the foundational knowledge that's needed to get started with Python in the computational geosciences, as well as to become an effective citizen-practitioner in key open geoscience software ecosystems. The intended audience is anyone from undergraduate students through established geoscientists who are relatively new to working in Python. The tutorials in this book also serve as references and prerequisites for the more advanced and domain-specific content in the [Pythia Cookbook Gallery](https://cookbooks.projectpythia.org). +Pythia Foundations is a geoscience-flavored introduction to essential +tools in the Scientific Python Ecosystem (SPE) and [Pangeo](https://pangeo.io) +stack. It covers the foundational knowledge that's needed to get started +with Python in the computational geosciences, as well as to become an +effective citizen-practitioner in key open geoscience software ecosystems. +The intended audience is anyone from undergraduate students through +established geoscientists who are relatively new to working in Python. +The tutorials in this book also serve as references and prerequisites +for the more advanced and domain-specific content in the [Pythia Cookbook Gallery](https://cookbooks.projectpythia.org). ## What's included From ed92dd73f85edaa8359cdcca49ac36d8b40e827e Mon Sep 17 00:00:00 2001 From: Robert Ford <50349951+r-ford@users.noreply.github.com> Date: Wed, 13 May 2026 11:39:55 -0400 Subject: [PATCH 2/6] Update md tutorial --- foundations/markdown.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/foundations/markdown.md b/foundations/markdown.md index 7aa8876b84..e7b83d0710 100644 --- a/foundations/markdown.md +++ b/foundations/markdown.md @@ -1,9 +1,8 @@ # Formatted Text in the Notebook with Markdown -```{note} -This content is under construction! -``` +Markdown is a simple, human-readable text language used extensively in Jupyter notebooks, on GitHub, and elsewhere. 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). -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. - -We will show how this is useful both in notebooks and other places like GitHub Issues. +Markdown was briefly mentioned in the previous section in the context of Jupyter notebooks. Here we provide a list of recommended resources for learning more. +- To learn the basics: the [CommonMark docs](https://commonmark.org/help/), including their [10-minute interactive tutorial](https://commonmark.org/help/tutorial/) +- 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 +- To learn everything that you can do with MyST: the [Authoring section of the MyST guide](https://mystmd.org/guide/typography) From 98a6f574bc2859024d838411dd3e6b767a0cf1be Mon Sep 17 00:00:00 2001 From: Robert Ford <50349951+r-ford@users.noreply.github.com> Date: Wed, 13 May 2026 17:59:15 -0400 Subject: [PATCH 3/6] Update foundations/markdown.md Co-authored-by: Brian Rose --- foundations/markdown.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/foundations/markdown.md b/foundations/markdown.md index e7b83d0710..bb720c3ea8 100644 --- a/foundations/markdown.md +++ b/foundations/markdown.md @@ -1,6 +1,9 @@ # Formatted Text in the Notebook with Markdown -Markdown is a simple, human-readable text language used extensively in Jupyter notebooks, on GitHub, and elsewhere. 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). +Markdown is a simple, human-readable text language used extensively in Jupyter notebooks, on GitHub, and elsewhere. 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. + +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). +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). Markdown was briefly mentioned in the previous section in the context of Jupyter notebooks. Here we provide a list of recommended resources for learning more. - To learn the basics: the [CommonMark docs](https://commonmark.org/help/), including their [10-minute interactive tutorial](https://commonmark.org/help/tutorial/) From 5501cd691bc25f406e3fb018c52059937d277225 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 13 May 2026 22:00:56 +0000 Subject: [PATCH 4/6] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- foundations/markdown.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/foundations/markdown.md b/foundations/markdown.md index bb720c3ea8..ea1e8b6de4 100644 --- a/foundations/markdown.md +++ b/foundations/markdown.md @@ -2,7 +2,7 @@ Markdown is a simple, human-readable text language used extensively in Jupyter notebooks, on GitHub, and elsewhere. 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. -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). +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). 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). Markdown was briefly mentioned in the previous section in the context of Jupyter notebooks. Here we provide a list of recommended resources for learning more. From 598b30a3bf9b73bbe0064848c910c2bd26eab6d2 Mon Sep 17 00:00:00 2001 From: Robert Ford <50349951+r-ford@users.noreply.github.com> Date: Thu, 14 May 2026 11:16:59 -0400 Subject: [PATCH 5/6] Apply suggestions from code review Co-authored-by: Brian Rose --- foundations/markdown.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/foundations/markdown.md b/foundations/markdown.md index ea1e8b6de4..dab0f35f9c 100644 --- a/foundations/markdown.md +++ b/foundations/markdown.md @@ -1,11 +1,11 @@ # Formatted Text in the Notebook with Markdown -Markdown is a simple, human-readable text language used extensively in Jupyter notebooks, on GitHub, and elsewhere. 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. +{term}`Markdown` is a simple, human-readable text language used extensively in {term}`Jupyter Notebooks`, on {term}`GitHub`, and elsewhere. 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. 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). 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). -Markdown was briefly mentioned in the previous section in the context of Jupyter notebooks. Here we provide a list of recommended resources for learning more. +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. - To learn the basics: the [CommonMark docs](https://commonmark.org/help/), including their [10-minute interactive tutorial](https://commonmark.org/help/tutorial/) - 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 - To learn everything that you can do with MyST: the [Authoring section of the MyST guide](https://mystmd.org/guide/typography) From 09f12b949973ac3a4b0336c096bcc5f0178a5f2a Mon Sep 17 00:00:00 2001 From: Robert Ford <50349951+r-ford@users.noreply.github.com> Date: Thu, 14 May 2026 11:29:15 -0400 Subject: [PATCH 6/6] Add Markdown to glossary --- appendix/glossary.md | 3 +++ foundations/markdown.md | 4 ++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/appendix/glossary.md b/appendix/glossary.md index d3472f0e7e..afe0f3f6d8 100644 --- a/appendix/glossary.md +++ b/appendix/glossary.md @@ -88,6 +88,9 @@ Linux local : Refering to something, such as a {term}`Git` repository, on your computer rather than a remote server. +Markdown +: 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. + merge : A specific type of commit that combines changes from two branches. diff --git a/foundations/markdown.md b/foundations/markdown.md index dab0f35f9c..0fbcdd70aa 100644 --- a/foundations/markdown.md +++ b/foundations/markdown.md @@ -1,9 +1,9 @@ # Formatted Text in the Notebook with Markdown -{term}`Markdown` is a simple, human-readable text language used extensively in {term}`Jupyter Notebooks`, on {term}`GitHub`, and elsewhere. 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. +{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. 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). -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). +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). 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. - To learn the basics: the [CommonMark docs](https://commonmark.org/help/), including their [10-minute interactive tutorial](https://commonmark.org/help/tutorial/)