Skip to content
Snippets Groups Projects
markdown_cheatsheet.ipynb 8.26 KiB
Newer Older
{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Markdown cheat sheet"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "##  Markdown Zellen\n",
    "\n",
    "Eine Markdown-Zelle (oder Text-Zelle oder HTML-Zelle) in Jupyter-Notebook ist im Gegensatz zu einer Code-Zelle eine Zelle, deren Inhalt nicht aus Code bestehen soll und auch nicht vom Python Interpreter ausgeführt werden kann. \n",
    "\n",
    "Stattdessen soll in diesen Zellen Text (Theorie, Aufgaben, Notizen und verschriftliche Lösungen) stehen. Diesen Text kann man auf verschiedene Weise strukturieren und übersichtlich gestalten. Im Folgenden werden dazu verschieden Möglichkeiten gezeigt.\n",
    "\n",
    "Die jeweiligen Beispiele kann man natürlich nur sehen, wenn man in den Editormodus der Zelle springt.\n",
    "\n",
    "<hr style=\"border:2px solid gray\"> </hr>"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## 1. Überschriften\n",
    "\n",
    "Überschriften kann man über das **Rauten-Symbol (#)** darstellen. \n",
    "Dazu fügt man einfach am Anfang der Zeile eine (oder mehrer) Rauten hinzu.  \n",
    "Je mehr Rautensymbole man hinzufügt, desto kleiner wird die Schrift. Zwischen der letzten Raute und dem anschließenden Text muss ein Leerzeichen stehen.\n",
    "\n",
    "Syntax: \n",
    "\n",
    "`# Text`\n",
    "\n",
    "Beispiele:\n",
    "\n",
    "\n",
    "# Text (1)\n",
    "## Text (2)\n",
    "### Text (3)\n",
    "#### Text (4)\n",
    "\n",
    "<hr style=\"border:2px solid gray\"> </hr>"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## 2. Aufzählungen\n",
    "\n",
    "Aufzählungen sind durch das **Minus-, Plus- oder Multiplikationssymbol** möglich. Im Editiermodus werden die Aufzählungen farbig gekennzeichnet.\n",
    "\n",
    "Syntax: \n",
    "\n",
    "`- Text`\n",
    "\n",
    "`+ Text`\n",
    "\n",
    "`* Text`\n",
    "\n",
    "\n",
    "Beispiel:\n",
    "- Text (1)\n",
    "- Text (2)\n",
    "\n",
    "Durch die Tab-Taste kann man zusätzlich **Aufzählungen verschachteln**.\n",
    "Die verschachtelten Aufzählungen bekommen verschiedene Aufzählungszeichen und werden im Editiermodus farbig gekennzeichnet.\n",
    "Syntax:\n",
    "<pre>\n",
    "- Text\n",
    "    - Text\n",
    "</pre>\n",
    "\n",
    "Beispiel:\n",
    "- Text (1)\n",
    "    - Text (2)\n",
    "    \n",
    "Zudem kann man die **Aufzählungen auch nummerieren**. \n",
    "\n",
    "Syntax:\n",
    "\n",
    "`1. Text`\n",
    "\n",
    "`2. Text`\n",
    "\n",
    "Beispiel\n",
    "1. Text\n",
    "2. Text\n",
    "\n",
    "<hr style=\"border:2px solid gray\"> </hr>"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## 3. Schriftauszeichnung\n",
    "\n",
    "Es gibt verschiedene Möglichkeiten, Textteile innerhalb eines Textes auszuzeichnen oder hervorzuheben.\n",
    "\n",
    "**Fettgedruckt**:\n",
    "- Syntax: `**Text**`\n",
    "- Beispiel: **Text**\n",
    "       \n",
    "    \n",
    "*Kursiv*: \n",
    " - Syntax: `*Text*`\n",
    " - Beispiel: *Text*\n",
    "     \n",
    "~~Durchgestrichen~~:\n",
    " - Syntax: `~~Text~~`\n",
    " - Beispiel: ~~Text~~\n",
    " \n",
    "`Hervorheben`:\n",
    "- Syntax: `` ` ``Text`` ` ``\n",
    "- Beispiel: `Text`\n",
    " \n",
    "<hr style=\"border:2px solid gray\"> </hr>\n",
    "\n",
    "#### Zusätzlich kann man HTML code nutzen:\n",
    "\n",
    "<u>Unterstrichen</u>:\n",
    "- Syntax: `<u>` Text `</u>`\n",
    "- Beispiel: <u> Text </u>\n",
    "    \n",
    " \n",
    "<font color = green>Farbig</font>: \n",
    "- Syntax: ` <font color = red>` Text `</font>`\n",
    "- Beispiel: <font color = red>Text</font>\n",
    "- Farbauswahl: red, yellow, blue, orange, purple, etc.\n",
    "    \n",
    "<font color = #ff0000>Farbig (#rrggbb)</font>: \n",
    "- Syntax:`<font color = #ff0000>` Text `</font>` \n",
    "- Beispiel:<font color = #ff16f0>Text</font>\n",
    "- Farbauswahl: alle rgb Farben (Code #rrggbb) \n",
    "    \n",
    "    \n",
    "<span style=\"color: rgb(250,100,0)\">Farbig mit span-Befehl</span>: \n",
    "- Syntax: `<span style=\"color: rgb(255,0,0)\">` Text `</span>`\n",
    "- Beispiel:<span style=\"color: rgb(0,0,255)\">Text</span>\n",
    "- Farbauswahl: alle rgb Farben ([0-255],[0-255],[0-255])\n",
    "    \n",
    "    \n",
    "<span style=\"background-color:rgb(150,150,50)\">Hintergrundfarbe </span>:\n",
    "- Syntax:`<font color = #ff0000>` Text `</font>` \n",
    "- Beispiel:<font color = #ff16f0>Text</font>\n",
    "\n",
    "<hr style=\"border:2px solid gray\"> </hr>"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## 4. Noch mehr Möglichkeiten\n",
    "\n",
    "#### Zeilenumbrüche\n",
    "Zeilenumbrüche funktionieren einfach durch zwei Leerzeichen hinter dem letzten Buchstaben in der Zeile oder durch den Befehl `<br>` \n",
    "\n",
    "Syntax: \n",
    "\n",
    "`Text <br>`\n",
    "\n",
    "Beispiel:\n",
    "\n",
    "Text  \n",
    "Text <br>\n",
    "Text\n",
    "\n",
    "<hr style=\"border:2px solid gray\"> </hr>\n",
    "\n",
    "#### Absätze\n",
    "Absätze funktionieren durch eine leere Zeile zwischen den Texten.\n",
    "\n",
    "Syntax:\n",
    "\n",
    "`Text`\n",
    "\n",
    "` `\n",
    "\n",
    "`Text`\n",
    "\n",
    "Beispiel:\n",
    "\n",
    "Text\n",
    "\n",
    "Text\n",
    "\n",
    "<hr style=\"border:2px solid gray\"> </hr>\n",
    "\n",
    "#### Horizontale Linien\n",
    "Drei Sterne, Minus, oder Unterstriche ergeben eine graue horizontale Linie:\n",
    "\n",
    "Syntax:\n",
    "\n",
    "`***`\n",
    "\n",
    "`---`\n",
    "\n",
    "`___`\n",
    "\n",
    "Beispiel:\n",
    "\n",
    "***\n",
    "\n",
    "---\n",
    "\n",
    "___\n",
    "\n",
    "\n",
    "Um dickere Linien zu erzeugen, braucht man html Code:\n",
    "\n",
    "Syntax:\n",
    "\n",
    "`<hr style=\"border:2px solid gray\"> </hr>`\n",
    "\n",
    "\n",
    "<hr style=\"border:2px solid gray\"> </hr>\n",
    "\n",
    "#### Python Code anzeigen\n",
    "Manchmal möchte man Python-Code einfach in einer Notiz festhalten und ihn deswegen in eine Markdown-Zelle schreiben. Dort kann er nicht ausgeführt werden. \n",
    "\n",
    "Syntax:\n",
    "\n",
    "`` ``` `` \n",
    "\n",
    "Python-Code (Zeile 1)\n",
    "\n",
    "Python Code (Zeile 2)\n",
    "\n",
    "`` ``` `` \n",
    "\n",
    "Beispiel:\n",
    "```\n",
    "for i in range(10):\n",
    "    print(i)\n",
    "```\n",
    "\n",
    "<hr style=\"border:2px solid gray\"> </hr>\n",
    "\n",
    "#### Zitieren/ Einrücken:\n",
    "Durch das Zeichen `>` könnt ihr einen Text einrücken und abgrenzen.\n",
    "\n",
    "Syntax :\n",
    "\n",
    "`>`\n",
    "\n",
    "Beispiel:\n",
    "\n",
    "> Text\n",
    "\n",
    "<hr style=\"border:2px solid gray\"> </hr>\n",
    "\n",
    "#### mathematische Formeln\n",
    "\n",
    "Mathematische Formeln können durch zwischen zwei Dollarzeichen dargestellt werden.\n",
    "\n",
    "Syntax:\n",
    "\n",
    "`$` Formel `$`\n",
    "\n",
    "Beispiel:\n",
    "\n",
    "$f(x)= ax² +bx +c$\n",
    "\n",
    "<hr style=\"border:2px solid gray\"> </hr>\n",
    "\n",
    "#### Links\n",
    "\n",
    "Syntax:\n",
    "\n",
    "`[beschreibender Text der Seite](url)`\n",
    "\n",
    "Beispiel:\n",
    "\n",
    "[Das ist die moodle Seite des Programmierkurses](https://moodle.hu-berlin.de/course/view.php?id=97747)\n",
    "\n",
    "\n",
    "<hr style=\"border:2px solid gray\"> </hr>\n",
    "\n",
    "#### Tabellen\n",
    "Man kann auch Tabellen erstellen. Eine senkrechter Strich `|` teilt die Spalten ein, Minus zwischen den senkrechten Strichen sind für die horizontalen Reihen.  \n",
    "Es muss in **jeder Reihe dieselbe Anzahl an senkrechten Strichen** geben.\n",
    "\n",
    "Syntax:\n",
    "\n",
    "`Spalte1 | Spalte2 | Spalte3`\n",
    "\n",
    "`--- | --- | ---`\n",
    "\n",
    "`Text |  Text | Text`\n",
    "\n",
    "Beispiel:\n",
    "\n",
    "Spalte1 | Spalte2 | Spalte3 \n",
    "-| -| -\n",
    "~~Text~~| *Text* | **Text**\n",
    "~~Text~~| *Text* | **Text**\n",
    "~~Text~~| *Text* | **Text**\n"
   ]
  }
 ],
 "metadata": {
  "language_info": {
   "name": "python",
   "pygments_lexer": "ipython3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}