|
23 | 23 | "* Green\n",
|
24 | 24 | "* Blue\n",
|
25 | 25 | "\n",
|
26 |
| - "Note: JupyterLab and JupyterNotebook uses a different Markdown parser than nbsphinx (which currently uses Pandoc). \n", |
27 |
| - "In case that your Bulletpoints do render in the notebook and do not render with nbsphinx, please add one blank line before the bulletpoints.\n", |
28 |
| - "***\n", |
| 26 | + "JupyterLab and JupyterNotebook use a different Markdown parser than nbsphinx\n", |
| 27 | + "(which currently uses Pandoc). When using Pandoc v2.0 or later, nbsphinx uses\n", |
| 28 | + "GitHub-flavored markdown, this is the same standard of markdown used by\n", |
| 29 | + "JupyterLab and JupyterNotebook.\n", |
29 | 30 | "\n",
|
| 31 | + "In particular, newer versions of nbsphinx (>v0.9.5) will now correctly convert\n", |
| 32 | + "lists without a blank line:\n", |
| 33 | + "\n", |
| 34 | + "```markdown\n", |
| 35 | + "No new line before this list:\n", |
| 36 | + "1. One\n", |
| 37 | + "2. Two\n", |
| 38 | + "3. Three\n", |
| 39 | + "```\n", |
| 40 | + "No new line before this list:\n", |
30 | 41 | "1. One\n",
|
31 |
| - "1. Two\n", |
32 |
| - "1. Three\n", |
| 42 | + "2. Two\n", |
| 43 | + "3. Three\n", |
| 44 | + "\n", |
| 45 | + "\n", |
| 46 | + "Arbitrary Unicode characters should be supported, e.g. łßō. Note, however, that\n", |
| 47 | + "this only works if your HTML browser and your LaTeX processor provide the\n", |
| 48 | + "appropriate fonts." |
| 49 | + ] |
| 50 | + }, |
| 51 | + { |
| 52 | + "cell_type": "markdown", |
| 53 | + "metadata": {}, |
| 54 | + "source": [ |
| 55 | + "## Task Lists\n", |
33 | 56 | "\n",
|
34 |
| - "Arbitrary Unicode characters should be supported, e.g. łßō.\n", |
35 |
| - "Note, however, that this only works if your HTML browser and your LaTeX processor provide the appropriate fonts." |
| 57 | + "nbsphinx supports GitHub-style task lists:\n", |
| 58 | + "\n", |
| 59 | + "```\n", |
| 60 | + "- [x] Task 1\n", |
| 61 | + "- [ ] Task 2\n", |
| 62 | + "- [ ] Task 3\n", |
| 63 | + "```\n", |
| 64 | + "- [x] Task 1\n", |
| 65 | + "- [ ] Task 2\n", |
| 66 | + "- [ ] Task 3" |
36 | 67 | ]
|
37 | 68 | },
|
38 | 69 | {
|
|
0 commit comments