Skip to content

Commit 0a5a718

Browse files
committed
sentence case
1 parent 05eed9a commit 0a5a718

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

nbs/tutorials/blogging.ipynb

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
"id": "0b71025a-455d-4cd7-a196-6ebd5cc4f519",
5151
"metadata": {},
5252
"source": [
53-
"## Migrating From fastpages\n",
53+
"## Migrating from fastpages\n",
5454
"\n",
5555
"If you previously had a fastpages site, we offer some utilities to help migrate you to Quarto. **The migration is not holistic: you will likely have to manually correct some things that we are not able to automate.**\n",
5656
"\n",
@@ -136,11 +136,11 @@
136136
"id": "3f00ffc1-295a-4de5-b71f-92cde47d3a84",
137137
"metadata": {},
138138
"source": [
139-
"### Configuration Options: fastpages vs. Quarto\n",
139+
"### Configuration options: fastpages vs. Quarto\n",
140140
"\n",
141141
"fastpages (which was based on Jekyll) and Quarto offer different kinds of options and configurations for individual posts and at a site level. Below are some tables that organize some of the most important features of fastpages and how it maps to Quarto. Each link in the last column is specific to the relevant feature.\n",
142142
"\n",
143-
"#### Post Level Front Matter\n",
143+
"#### Post-level options\n",
144144
"\n",
145145
"Jekyll Front Matter | Quarto | Notes\n",
146146
"-- | -- | --\n",
@@ -158,7 +158,7 @@
158158
"\n",
159159
"\n",
160160
"\n",
161-
"#### Site Level Options\n",
161+
"#### Site-level options\n",
162162
"\n",
163163
"Jekyll site config | Quarto | Notes\n",
164164
"-- | -- | --\n",
@@ -181,7 +181,7 @@
181181
"id": "8ee5b80e-7931-4d03-8f3e-c8010c36279c",
182182
"metadata": {},
183183
"source": [
184-
"## Publishing Your Blog\n",
184+
"## Publishing your blog\n",
185185
"\n",
186186
"::: {.callout-warning}\n",
187187
"_This section is for stand-alone blogs that are not part of a nbdev documentation site. If you want to create a blog within a nbdev documentation site, see [this section](#creating-a-blog-within-a-nbdev-project)._\n",
@@ -198,7 +198,7 @@
198198
":::\n",
199199
"\n",
200200
"\n",
201-
"## Creating A Blog Within A nbdev Project\n",
201+
"## Creating a blog within a nbdev project\n",
202202
"\n",
203203
"In addition to a stand-alone blog that you might build with Quarto, you might want to include a blogging site in your nbdev project. This website has [a blog](../blog/) as well! The easiest way to implement a blog is to emulate the directory structure of [this folder](https://github.com/fastai/nbdev/tree/master/nbs/blog). The general steps are:\n",
204204
"\n",
@@ -243,7 +243,7 @@
243243
"5. **Create your first blog post**: You can emulate our example or create your own. In each folder, create a `index.qmd` or `index.ipynb` file. You can also put images and related assets in the same folder.\n",
244244
"\n",
245245
"\n",
246-
"### Folder Structure\n",
246+
"### Folder structure\n",
247247
"\n",
248248
"Below is an overview of the general folder structure for a blog within a nbdev site:\n",
249249
"\n",
@@ -267,7 +267,7 @@
267267
"- `posts/`: this a subdirectory for each blog post.\n",
268268
"- `YYYY-MM-DD-.../index.{qmd,ipynb}`: this is where you author the content of each individual blog post.\n",
269269
"\n",
270-
"### Special Considerations For nbdev blogs\n",
270+
"### Special considerations for nbdev blogs\n",
271271
"\n",
272272
"In contrast to standalone Quarto blogs, when you embed a blog in a nbdev website there are the following differences:\n",
273273
"\n",
@@ -280,7 +280,7 @@
280280
"id": "700589e2-aca4-44a4-b82d-167f63f55758",
281281
"metadata": {},
282282
"source": [
283-
"## Using nbdev Features in Blogs Outside nbdev Projects\n",
283+
"## Using nbdev features in blogs outside nbdev projects\n",
284284
"\n",
285285
"::: {.callout-warning}\n",
286286
"_This section is for stand-alone blogs that are not part of a nbdev documentation site. If you create a blog within a nbdev documentation site, all nbdev features will automatically work._\n",

nbs/tutorials/modular_nbdev.ipynb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
"id": "b838f2c9-c24a-457c-9401-40708c5bfba0",
2626
"metadata": {},
2727
"source": [
28-
"## Document Existing Code: `show_doc`\n",
28+
"## Document existing code: `show_doc`\n",
2929
"\n",
3030
"nbdev allows you to document existing code, even code that is not written in nbdev! `nbdev.showdoc.show_doc` allows you to render beautiful API documentation in notebooks and on Quarto sites. For example, you can render API documentation for `numpy.all` like this: \n",
3131
"\n",
@@ -110,7 +110,7 @@
110110
"id": "5de0e130",
111111
"metadata": {},
112112
"source": [
113-
"## Testing Notebooks: `nbdev_test`\n",
113+
"## Testing notebooks: `nbdev_test`\n",
114114
"\n",
115115
"Testing notebooks can be very useful outside of nbdev, especially if you are documenting an existing code base and want to incorporate tests for your docs. The `nbdev_test` CLI utility allows you to accomplish this:"
116116
]
@@ -138,7 +138,7 @@
138138
"id": "a2a38c4e",
139139
"metadata": {},
140140
"source": [
141-
"## Export Code To Modules: `nb_export`"
141+
"## Export code to modules: `nb_export`"
142142
]
143143
},
144144
{
@@ -160,7 +160,7 @@
160160
"id": "77673b03",
161161
"metadata": {},
162162
"source": [
163-
"## Jupyter-Git Integration\n",
163+
"## Jupyter-git integration\n",
164164
"\n",
165165
"Jupyter and Git don't normally play well together, especially for things like merge conflicts. We have outlined all of these problems, and our solutions in [this blog post](../blog/posts/2022-08-25-jupyter-git/index.qmd). You can install our merge driver and hooks with the following command: \n",
166166
"\n",
@@ -197,7 +197,7 @@
197197
"id": "7f6c261f-d47f-4d1a-a695-05370f81a9c9",
198198
"metadata": {},
199199
"source": [
200-
"## Python Packaging"
200+
"## Python packaging"
201201
]
202202
},
203203
{

0 commit comments

Comments
 (0)