Skip to content

Commit cfd52e8

Browse files
JimMadgeJimMadge
committed
Add Jupyter Book introduction section
1 parent eae8632 commit cfd52e8

File tree

3 files changed

+102
-19
lines changed

3 files changed

+102
-19
lines changed

‎index.html‎

Lines changed: 101 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -74,31 +74,113 @@ <h2>Installing Jupyter Book</h2>
7474
<!-- LISTENING: Introduction to Jupyter Book -->
7575
<section>
7676
<h2>Jupyter Book</h2>
77-
<aside data-markdown class="notes">
78-
- Jupyter Book is a system for creating reproducible, reusable and interactive documents
79-
- Source is written in MyST Markdown (an extension of common mark) or Jupyter Notebook
80-
- Typography features
81-
- Lists
82-
- Tables
83-
- Figures
84-
- Maths
85-
- Tabs, dropdowns
86-
- More …
87-
- Interactive content
77+
<section>
78+
<img class="r-stretch" alt="The Jupyter Book logo, formed of text reading jupyter book where the word book is surrounded by braces." src="static/jb_logo.svg">
79+
<blockquote> Create documents and knowledge bases that are reusable, reproducible, and interactive.</blockquote>
80+
<ul class="fragment custom blur">
81+
<li>Features for beautiful typesetting, in many domains</li>
82+
<li>Builds from MyST Markdown or Jupyter Notebooks</li>
83+
</ul>
84+
<aside data-markdown class="notes">
85+
- Jupyter Book is a system for creating reproducible, reusable and interactive documents
86+
- Many features
87+
- Typography
88+
- Structure
89+
- Lists
90+
- Tables
91+
- Tabs, dropdowns
92+
- Technical
93+
- Maths
94+
- Code
95+
- Diagrams
96+
- Media
97+
- Figures
98+
- Videos
99+
- More …
100+
- Source is written in MyST Markdown (an extension of common mark) or Jupyter Notebook
101+
</aside>
102+
</section>
103+
<section>
104+
<div class="columns">
105+
<div class="column" style="width: 50%">
106+
<h4>Executable content</h4>
107+
<ul>
108+
<li class="fragment highlight-current-green" data-fragment-index="1"><b>Jupyter Notebooks</b></li>
109+
<li class="fragment highlight-current-green" data-fragment-index="2"><code>code-cell</code> blocks in <b>Markdown</b></li>
110+
<li class="fragment highlight-current-green" data-fragment-index="3"><b>Inline statements</b> using <code>eval</code> in Markdown</li>
111+
</ul>
112+
</div>
113+
<div class="column" style="width: 50%">
114+
<div class="r-stack">
115+
<img class="fragment current-visible" data-fragment-index="1" alt="Screenshot of a Jupyter Notebook session where one cell defines a function for the Fibonacci series" src="static/notebook.png">
116+
<pre class="fragment current-visible" data-fragment-index="2"><code data-trim class="language-markdown">
117+
# Title
118+
119+
```{code-cell} python
120+
hello = "hello"
121+
there = "there"
122+
phrase = f"{hello}, {there}!"
123+
print(phrase)
124+
```
125+
</code></pre>
126+
<pre class="fragment current-visible" data-fragment-index="3"><code data-trim class="language-markdown">
127+
# Title
128+
129+
1 + 1 is {eval}`1 + 1`
130+
</code></pre>
131+
<div class="fragment">
132+
<h4>Executing</h4>
133+
<ul>
134+
<li>At <b>build</b> time</li>
135+
<li><b>Live</b> in a browser</li>
136+
</ul>
137+
</div>
138+
</div>
139+
</div>
140+
</div>
141+
<aside data-markdown class="notes">
88142
- Executable content in
89143
- Cells in a Jupyter Notebook (`.ipynb`)
90144
- `code-cell` blocks in Markdown files
91145
- Inline code using the `eval` role
92146
- Can execute at build time with a local Jupyter server and kernel
93147
- Can execute on the page by connecting to a Jupyter server and kernel (_e.g._ MyBinder)
94-
- Powerful and flexible plugin system
95-
- Reusable: content can be referenced or embedded from other Jupyter Books
96-
- Exports to HTML, PDF (LaTeX and Typst), word, JATS
97-
- Through intermediate AST
98-
- History:
99-
- Jupyter Book 1, based on Sphinx documentation engine, supported MyST Markdown input through myst-parser
100-
- Jupyter Book 2, a distribution of MyST MD document engine
101-
</aside>
148+
</aside>
149+
</section>
150+
<section>
151+
<h3>More features!</h3>
152+
<ul>
153+
<li>Plugins</li>
154+
<li>Cross-book references and embedding</li>
155+
<li>Multiple export formats (HTML, pdf, docx, JATS)</li>
156+
</ul>
157+
<aside data-markdown class="notes">
158+
- Powerful and flexible plugin system
159+
- Reusable: content can be referenced or embedded from other Jupyter Books
160+
- Exports to HTML, PDF (LaTeX and Typst), word, JATS
161+
- Through intermediate AST
162+
</aside>
163+
</section>
164+
<section>
165+
<div class="columns">
166+
<div class="column" style="width: 50%">
167+
<h4>Jupyter Book 1</h4>
168+
MyST Parser</br>
169+
Sphinx</br>
170+
<i class="fa-brands fa-python"></i>
171+
</div>
172+
<div class="column" style="width: 50%">
173+
<h4>Jupyter Book 2</h4>
174+
mystmd</br>
175+
<i class="fa-brands fa-node"></i>
176+
</div>
177+
</div>
178+
<aside data-markdown class="notes">
179+
- History:
180+
- Jupyter Book 1, based on Sphinx documentation engine, supported MyST Markdown input through myst-parser
181+
- Jupyter Book 2, a distribution of MyST MD document engine
182+
</aside>
183+
</section>
102184
</section>
103185
<!-- LISTENING: Introduction to The Turing Way -->
104186
<section>

‎static/jb_logo.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎static/notebook.png‎

39.1 KB
Loading

0 commit comments

Comments
 (0)