fixed some formatting issues and added infos on markdown in notebooks

Signed-off-by: Christian Münker <[email protected]>
chipmuenk · Sep 26, 2022 · dea9abd · dea9abd
1 parent e7b65f4
commit dea9abd
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 240 deletions.
diff --git a/notebooks/00_Intro/intro-markdown-formatierung.ipynb b/notebooks/00_Intro/intro-markdown-formatierung.ipynb
@@ -6,28 +6,30 @@
    "source": [
     "# Textformatierung mit Markdown in Notebook-Zellen\n",
     "\n",
+    "## Markdown in Notebooks\n",
     "Textzellen (so wie diese) in Jupyter Notebooks werden in\n",
     "[Markdown](https://www.ionos.de/digitalguide/websites/web-entwicklung/markdown/) Syntax \n",
-    "formatiert. \n",
-    "Markdown ist eine einfache Auszeichnungssprache (\"lightweight markup format\"),\n",
-    "die u.a. bei GitHub, Stack Overflow, Slack und zahlreichen anderen webbasierten Diensten \n",
-    "eingesetzt wird. Hauptvorteil ist, dass man Text einfach schreiben \n",
-    "und auch ungerendert leicht lesen zu kann (z.B. im Vergleich zu $\\LaTeX$).\n",
-    "Probieren Sie es aus bringen Sie diese Zelle in den Bearbeitungsmodus.\n",
+    "geschrieben, einer einfachen Auszeichnungssprache (\"lightweight markup format\"), die man auch ungerendert leicht lesen kann (z.B. im Gegensatz zu $\\LaTeX$) und die man auch ohne speziellen Editor leicht schreiben kann. Markdown wird u.a. bei GitHub, Stack Overflow, Slack und zahlreichen anderen webbasierten Diensten \n",
+    "eingesetzt.\n",
+    "\n",
+    "Textzellen in einem Notebook müssen als \"Text\" bzw. \"Markdown\" ausgewählt werden. Um eine Markdown-Zelle zu verändern, muss man sie genau wie eine Codezelle in den Bearbeitungsmodus bringen (Doppelclick), zum Rendern \"führt man sie aus\" (SHIFT-RETURN).\n",
+    "\n",
     "Mit [pandoc](https://pandoc.org/) kann Markdown in zahlreiche andere Formate\n",
     "umgewandelt werden.\n",
     "\n",
     "Es gibt unterschiedliche Markdown-Dialekte (z.B. \"GitHub Flavoured\"), also nicht wundern falls\n",
     "nicht alles 100% so klappt wie erwartet.\n",
     "\n",
     "Reine Markdown-Files (so wie die [Startseite](../README.md) dieses Repos) können in\n",
-    "JupyterLab als Split-Screen-Editor bearbeitet werden; in einem Tab bearbeitet man den Text,\n",
-    "in einem anderen erscheint die HTML-Vorschau (rechte Maustaste -> Show Markdown Preview).\n",
+    "JupyterLab oder VSCode im Split-Screen-Modus bearbeitet werden; in einem Tab bearbeitet man den Text,\n",
+    "in einem anderen erscheint die HTML-Vorschau (JupyterLab: rechte Maustaste -> Show Markdown Preview, VSCode: \"Vorschau an der Seite öffnen\").\n",
     "\n",
-    "[Heise Markdown Tipps und Cheatsheets](https://www.heise.de/mac-and-i/artikel/Markdown-bei-Mac-und-iOS-Apps-Tipps-und-Cheat-Sheet-2105025.html)\n",
+    "In diesem Kurs werden Sie Markdown für die Protokolle im Praktikum einsetzen.\n",
     "\n",
     "## Grundregeln:\n",
     "\n",
+    "[Heise Markdown Tipps und Cheatsheets](https://www.heise.de/mac-and-i/artikel/Markdown-bei-Mac-und-iOS-Apps-Tipps-und-Cheat-Sheet-2105025.html)\n",
+    "\n",
     "* Markdown ist ein Super-Set von HTML, daher können auch <code><b>HTML</b></code>-<kbd>Tags</kbd> \n",
     "  und <span style='color: blue; font-size: 20px;'>CSS</span> Formatierungen verwendet werden\n",
     "  ([mehr Info](https://www.w3schools.com/tags/)).\n",
@@ -49,28 +51,15 @@
    ]
   },
   {
-   "cell_type": "code",
-   "execution_count": 1,
+   "cell_type": "markdown",
    "metadata": {},
-   "outputs": [
-    {
-     "ename": "SyntaxError",
-     "evalue": "invalid syntax (3513550085.py, line 2)",
-     "output_type": "error",
-     "traceback": [
-      "\u001b[0;36m  File \u001b[0;32m\"/tmp/ipykernel_6591/3513550085.py\"\u001b[0;36m, line \u001b[0;32m2\u001b[0m\n\u001b[0;31m    Überschriften werden als HTML Header `<h1>` ... `<h6>` gerendert, abhängig von der\u001b[0m\n\u001b[0m                  ^\u001b[0m\n\u001b[0;31mSyntaxError\u001b[0m\u001b[0;31m:\u001b[0m invalid syntax\n"
-     ]
-    }
-   ],
    "source": [
     "## Überschriften (h2)\n",
     "Überschriften werden als HTML Header `<h1>` ... `<h6>` gerendert, abhängig von der \n",
     "Anzahl der \\# am Anfang der Zeile.\n",
     "\n",
     "### Heading (h3)\n",
     "\n",
-    "### Heading (h3)\n",
-    "\n",
     "#### Heading (h4)\n",
     "\n",
     "##### Heading (h5)\n",
@@ -114,10 +103,8 @@
    "source": [
     "## Code\n",
     "\n",
-    "Kurze Codeschnipsel werden zwischen einzelnen Backticks eingeschlossen, \\``print(3)`\\`\n",
-    "Codeblöcke zwischen drei Backticks (` ``` ... ``` `). Falls der Markdown\n",
-    "Prozessor Syntax Highlighting unterstützt, kann z.B. mit ` ```python` die Sprache angegeben \n",
-    "werden:\n",
+    "Kurze Codeschnipsel werden zwischen einzelnen Backticks eingeschlossen, \\``print(3)`\\` Codeblöcke zwischen drei Backticks (` ``` ... ``` `). Falls der Markdown\n",
+    "Prozessor Syntax Highlighting unterstützt, kann man z.B. mit ` ```python` die Sprache vorgeben:\n",
     "\n",
     "```python\n",
     "for i in range(10):\n",
@@ -210,11 +197,8 @@
  ],
  "metadata": {
   "anaconda-cloud": {},
-  "interpreter": {
-   "hash": "916dbcbb3f70747c44a77c7bcd40155683ae19c65e1c03b4aa3499c5328201f1"
-  },
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3.10.1 64-bit ('3.10.1')",
    "language": "python",
    "name": "python3"
   },
@@ -228,7 +212,12 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.7"
+   "version": "3.10.1"
+  },
+  "vscode": {
+   "interpreter": {
+    "hash": "fbae99ddb677cda40bb28db30acb8977ca8abff69fdc250ca7ac91c44d755d0e"
+   }
   }
  },
  "nbformat": 4,

diff --git a/notebooks/00_Intro/intro-markdown-formatierung_fix.ipynb b/notebooks/00_Intro/intro-markdown-formatierung_fix.ipynb