Skip to content

Commit 438e60c

Browse files
committed
conditional content
1 parent 53493ef commit 438e60c

File tree

2 files changed

+43
-26
lines changed

2 files changed

+43
-26
lines changed

README.md

Lines changed: 15 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,12 @@ Getting started
33

44
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
55

6-
**NB: This is nbdev v2, a new from-scratch rewrite of nbdev that’s not
7-
backwards compatible. Whilst the differences to nbdev1 aren’t huge, it
8-
does require some changes. So if you wish to continue to use nbdev1
9-
until you’ve got the time to upgrade, you can find the old version docs
10-
at [nbdev1.fast.ai](https://nbdev1.fast.ai). You can use version-pinning
11-
in your `requirements.txt` or `settings.ini` (i.e use `'nbdev<2'` as
12-
your dependency) to stop nbdev from being upgraded.**
6+
*NB: This is nbdev v2, a major upgrade of nbdev. Whilst the differences
7+
to nbdev1 aren’t huge, it does require some changes. The old version
8+
docs are at [nbdev1.fast.ai](https://nbdev1.fast.ai). You can use
9+
version-pinning in `settings.ini` (i.e `'nbdev<2'`) to stop nbdev from
10+
upgrading. To upgrade, follow the [migration
11+
tutorial](/migrating.html).*
1312

1413
------------------------------------------------------------------------
1514

@@ -68,8 +67,15 @@ The best way to learn to use nbdev is to complete one of these tutorials
6867
square in the bottom right of the video; to view in a separate Youtube
6968
window, click the Youtube logo):
7069

71-
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/l7zS8Ld4_iA" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen>
72-
</iframe>
70+
<div>
71+
72+
<div>
73+
74+
[![](images/walkthrough.png)](http://www.youtube.com/watch?v=l7zS8Ld4_iA "nbdev walkthrough")
75+
76+
</div>
77+
78+
</div>
7379

7480
(There’s an [alternate version of the
7581
walkthru](https://youtu.be/67FdzLSt4aA) avaialable with the coding
@@ -109,8 +115,6 @@ available commands:
109115
nbdev_trust Trust notebooks matching `fname`
110116
nbdev_update Propagate change in modules matching `fname` to notebooks that created them
111117

112-
## FAQ
113-
114118
### Q: Someone told me not to use notebooks for “serious” software development!
115119

116120
[Watch this video](https://youtu.be/9Q6sLbz37gk). Don’t worry, we still
@@ -121,20 +125,6 @@ clients](https://github.com/fastai/ghapi), [Python language
121125
extensions](https://github.com/fastai/fastcore), [terminal user
122126
interfaces](https://github.com/nat/ghtop), and more!
123127

124-
## nbdev in the wild
125-
126-
### fastai ecosystem
127-
128-
`nbdev` has been used to build innovative software in the fastai
129-
ecosystem, including the [`fastai`](https://docs.fast.ai/) deep learning
130-
library which implements a [unique layered API and callback
131-
system](https://arxiv.org/abs/2002.04688), and
132-
[`fastcore`](https://fastcore.fast.ai/), which supercharges Python
133-
leveraging its dynamic nature. Furthermore, `nbdev` allows a very small
134-
number of developers to maintain and grow a [large
135-
ecosystem](https://github.com/fastai) of software engineering, data
136-
science, machine learning, and devops tools.
137-
138128
## Contributing
139129

140130
If you want to contribute to `nbdev`, be sure to review the

nbs/getting_started.ipynb

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,22 @@
7979
"cell_type": "markdown",
8080
"metadata": {},
8181
"source": [
82-
"<iframe width=\"560\" height=\"315\" src=\"https://www.youtube-nocookie.com/embed/l7zS8Ld4_iA\" frameborder=\"0\" allow=\"accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture\" allowfullscreen></iframe>"
82+
"::: {.content-visible when-format=\"html\"}\n",
83+
"\n",
84+
"<iframe width=\"560\" height=\"315\" src=\"https://www.youtube-nocookie.com/embed/l7zS8Ld4_iA\" frameborder=\"0\" allow=\"accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture\" allowfullscreen></iframe>\n",
85+
"\n",
86+
":::"
87+
]
88+
},
89+
{
90+
"cell_type": "markdown",
91+
"metadata": {},
92+
"source": [
93+
"::: {.content-visible when-format=\"markdown\"}\n",
94+
"\n",
95+
"[![](images/walkthrough.png)](http://www.youtube.com/watch?v=l7zS8Ld4_iA \"nbdev walkthrough\")\n",
96+
"\n",
97+
":::"
8398
]
8499
},
85100
{
@@ -182,6 +197,18 @@
182197
"display_name": "Python 3 (ipykernel)",
183198
"language": "python",
184199
"name": "python3"
200+
},
201+
"language_info": {
202+
"codemirror_mode": {
203+
"name": "ipython",
204+
"version": 3
205+
},
206+
"file_extension": ".py",
207+
"mimetype": "text/x-python",
208+
"name": "python",
209+
"nbconvert_exporter": "python",
210+
"pygments_lexer": "ipython3",
211+
"version": "3.9.7"
185212
}
186213
},
187214
"nbformat": 4,

0 commit comments

Comments
 (0)