Notebooks with MyST Markdown#
+3. Notebooks with MyST Markdown#
Jupyter Book also lets you write text-based notebooks using MyST Markdown. See the Notebooks with MyST Markdown documentation for more detailed instructions. This page shows off a notebook written in MyST Markdown.
An example cell#
+3.1. An example cell#
With MyST Markdown, you can define code cells with a directive like so:
An example cell
-Create a notebook with MyST Markdown#
+3.2. Create a notebook with MyST Markdown#
MyST Markdown notebooks are defined by two things:
YAML metadata that is needed to understand if / how it should convert text files to notebooks (including information about the kernel needed).
@@ -435,7 +435,7 @@
Create a notebook with MyST Markdown
-Quickly add YAML metadata for MyST Notebooks#
+3.3. Quickly add YAML metadata for MyST Notebooks#
If you have a markdown file and you’d like to quickly add YAML metadata to it, so that Jupyter Book will treat it as a MyST Markdown Notebook, run the following command:
jupyter-book myst init path/to/markdownfile.md
@@ -481,7 +481,7 @@ Quickly add YAML metadata for MyST Notebooks
Quickly add YAML metadata for MyST Notebooks
@@ -509,9 +509,9 @@
Quickly add YAML metadata for MyST Notebooks
diff --git a/markdown.html b/markdown.html
index 6dd2dbb..edcd02d 100755
--- a/markdown.html
+++ b/markdown.html
@@ -8,7 +8,7 @@
- Markdown Files — DIG4BIO-workshops
+ 1. Markdown Files — DIG4BIO-workshops
@@ -60,7 +60,7 @@
-
+
@@ -181,10 +181,10 @@
-- Markdown Files
-- Content with notebooks
-- Notebooks with MyST Markdown
-- Here’s my sample title
+- 1. Alternative name
+- 2. Content with notebooks
+- 3. Notebooks with MyST Markdown
@@ -382,10 +382,10 @@ Contents
YAML metadata that is needed to understand if / how it should convert text files to notebooks (including information about the kernel needed). @@ -435,7 +435,7 @@
Create a notebook with MyST Markdown
-Quickly add YAML metadata for MyST Notebooks#
+3.3. Quickly add YAML metadata for MyST Notebooks#
If you have a markdown file and you’d like to quickly add YAML metadata to it, so that Jupyter Book will treat it as a MyST Markdown Notebook, run the following command:
jupyter-book myst init path/to/markdownfile.md
@@ -481,7 +481,7 @@ Quickly add YAML metadata for MyST Notebooks
Quickly add YAML metadata for MyST Notebooks
@@ -509,9 +509,9 @@
Quickly add YAML metadata for MyST Notebooks
diff --git a/markdown.html b/markdown.html
index 6dd2dbb..edcd02d 100755
--- a/markdown.html
+++ b/markdown.html
@@ -8,7 +8,7 @@
- Markdown Files — DIG4BIO-workshops
+ 1. Markdown Files — DIG4BIO-workshops
@@ -60,7 +60,7 @@
-
+
@@ -181,10 +181,10 @@
-- Markdown Files
-- Content with notebooks
-- Notebooks with MyST Markdown
-- Here’s my sample title
+- 1. Alternative name
+- 2. Content with notebooks
+- 3. Notebooks with MyST Markdown
@@ -382,10 +382,10 @@ Contents
jupyter-book myst init path/to/markdownfile.md
Quickly add YAML metadata for MyST Notebooks
Quickly add YAML metadata for MyST Notebooks
@@ -509,9 +509,9 @@
Quickly add YAML metadata for MyST Notebooks
-
-
- Here’s my sample title +
- 1. Alternative name +
- 2. Content with notebooks +
- 3. Notebooks with MyST Markdown
Contents
Contents
Markdown Files#
+1. Markdown Files#
Whether you write your book’s content in Jupyter Notebooks (.ipynb
) or
in regular markdown files (.md
), you’ll write in the same flavor of markdown
called MyST Markdown.
This is a simple file to help you get started and show off some syntax.
What is MyST?#
+1.1. What is MyST?#
MyST stands for “Markedly Structured Text”. It is a slight variation on a flavor of markdown called “CommonMark” markdown, with small syntax extensions to allow you to write roles and directives @@ -412,7 +412,7 @@