0 / 0
Zurück zur englischen Version der Dokumentation
Markdown-Cheatsheet
Letzte Aktualisierung: 07. Okt. 2024
Markdown-Cheatsheet

Sie können Markdown-Tags verwenden, um die Lesbarkeit der Readme-Datei eines Projekts oder der Markdown-Zellen in Jupyter-Notebooks zu verbessern. Auch auf die Unterschiede zwischen Markdown in Readme-Dateien und in Notebooks wird hingewiesen.

Überschriften: Verwenden #s mit einem anschließenden Leerzeichen für Notebook-Titel und Abschnittsüberschriften:

# Titel
## Hauptüberschriften
### Unterüberschriften
####Unterüberschriften der 4. Ebene

Hervorhebung: Verwenden Sie die folgenden Codes: Fett: __string__ oder **string**; Kursiv: _string_ oder *string*; Durchstreichen: ~~string~~

Mathematische Symbole: Verwenden Sie diesen Code: $ mathematical symbols $

Monospaceschriftart: Umgeben Sie Text mit einem hinteren einfachen Anführungszeichen (`). Verwenden Sie Monospaceschrift für Dateipfad und Dateinamen und für Text, den Benutzer eingeben oder Nachrichtentext anzeigen.

Zeilenumbrüche: In manchen Fällen fügt Markdown nicht die gewünschten Zeilenumbrüche ein. Geben Sie am Zeilenende zwei Leerzeichen ein oder verwenden Sie diesen Code für einen manuellen Zeilenumbruch: <br>

Eingerückte Anführungszeichen: Verwenden Sie ein Größer-als-Zeichen (> ) mit anschließendem Leerzeichen und geben Sie danach den Text ein. Der Text wird eingerückt und links vom Text befindet sich bis zum nächsten Wagenrücklauf eine graue horizontale Linie.

Listenpunkte: Verwenden Sie den Gedankenstrich (- ) mit anschließendem Leerzeichen oder Leerzeichen/Gedankenstrich/Leerzeichen (-), um einen runden Listenpunkt zu erstellen. Wenn Sie einen untergeordneten Listenpunkt erstellen möchten, verwenden Sie die Tabulatortaste und danach einen Gedankenstrich und ein Leerzeichen. Sie können alternativ anstatt des Gedankenstrichs (-) auch einen Stern (*) verwenden.

Nummerierte Listen: Geben Sie zuerst 1. mit anschließendem Leerzeichen und danach Ihren Text ein. Wenn Sie die Eingabetaste drücken, wird die Nummerierung automatisch durchgeführt. Beginnen Sie jede Zeile mit einer Zahl und einem Punkt gefolgt von einem Leerzeichen. Drücken Sie die Tabulatortaste, wenn Sie eine untergeordnete Nummerierung verwenden möchten.

Kontrollkästchen in Readme-Dateien: Verwenden Sie diesen Code für ein nicht Kontrollkästchen: - [ ]
Verwenden Sie diesen Code für ein Kontrollkästchen: - [x]

Tabellen in Readme-Dateien: Verwenden Sie diesen Code:

| Heading | Heading |
| ----| ----|
| text   | text |
| text | text |

Grafiken in Notebooks: Ziehen Sie Bilder in die Markdown-Zelle und legen Sie sie ab, um sie an das Notebook anzuhängen. Um Bilder in anderen Zellentypen hinzuzufügen, verwenden Sie im Web gehostete Grafiken mit dem folgenden Code. Ersetzen Sie dabei url/name durch die vollständige URL und den Namen des Bilds ersetzen: <img src="url/filename.gif" alt="Alt text" title="Title text" />.

Grafiken in Readme-Dateien: Verwenden Sie diesen Code: ![Alt text](url/filename.gif "Title text")

Geometrische Formen: Verwenden Sie diesen Code mit einer dezimalen oder hexadezimalen Referenznummer von UTF-8 Geometrische Formen &#reference_number;

Horizontale Linien: Verwenden Sie drei Sterne: ***

Interne Links: Um einen Link zu einem Abschnitt zu erstellen, fügen Sie einen Anker über dem Abschnittstitel hinzu und erstellen Sie anschließend einen Link.

Verwenden Sie diesen Code, um einen Anker zu erstellen: <a id="section_ID"></a>
Verwenden Sie diesen Code, um den Link zu erstellen: [section title](#section-ID)
Stellen Sie sicher, dass die Abschnitts-ID innerhalb des Notebooks oder der Readme-Datei eindeutig ist.

Alternativ können Sie bei Notebooks die Erstellung von Ankern überspringen und den folgenden Code verwenden: [section title](#section-title)
Ersetzen Sie für den Text in den Klammern Leerzeichen und Sonderzeichen durch einen Bindestrich und setzen Sie alle Zeichen in Kleinbuchstaben um.

Testen Sie alle Links!

Externe Links : Verwenden Sie diesen Code: [link text](http://url)

Verwenden Sie diesen Code, um einen Link zu erstellen, der in einem neuen Fenster oder einer neuen Registerkarte geöffnet wird: <a href="http://url" target="_blank" rel="noopener noreferrer">link text</a>

Testen Sie alle Links!

Übergeordnetes Thema: Projekte

Generative KI-Suche und -Antwort
Diese Antworten werden von einem großen Sprachmodell in watsonx.ai basierend auf dem Inhalt der Produktdokumentation generiert. Weitere Informationen