Merge pull request #1345 from drscotthawley/master

Added note that lists require blank lines before them

nbs/tutorials/best_practices.ipynb

@@ -117,7 +117,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "5a9742a4",
+   "id": "183b7e3e-d5a1-444b-90ae-540f2aa85d52",
    "metadata": {},
    "source": [
     "Introduce your notebook with markdown cells below the title. We recommend a slightly different approach depending on the [form of documentation](#know-which-form-of-notebook-youre-writing):\n",
@@ -127,6 +127,16 @@
     "- **Explanations:** Since these are typically very focused, a short description of the topic is often sufficient."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "3ada0a7c-ad5c-4dff-82d4-a1aaad8f3d29",
+   "metadata": {},
+   "source": [
+    "::: {.callout-tip appearance=\"simple\"}\n",
+    "Note that Markdown lists such as the one above require a blank line above them to be rendered as lists in the documentation, even though the notebook viewer will render lists that are not preceded by a blank line.\n",
+    ":::"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "0c76aa13",
@@ -1457,9 +1467,21 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "python3",
+   "display_name": "aa",
    "language": "python",
-   "name": "python3"
+   "name": "aa"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,