Markdown
Dialekte / Geschmacksrichtungen

Bemerkungen

Stapelüberlauf Markdown

Dies ist die Variante von Markdown, die von Stack Overflow und anderen Stack Exchange-Standorten verwendet wird. Wenn Sie eine Frage beantworten oder Dokumentation hinzufügen, verwenden Sie diese Abschrift. Diese Antwort wird aus dem SO-Abschlag gemacht

Siehe offizielle Dokumentation

Die wichtigsten Dinge, die SO Markdown hinzufügt, befinden sich unter "Stack Exchange-Ergänzungen" auf dieser Webseite. Insbesondere fügt SO Tags wie [tag:tag] und Verknüpfungslinks wie [meta] (nicht in Docs), Spoiler :

Dies ist ein Spoiler

>! This is a spoiler

und kundenspezifische Andachten

<!-- language: java -->
```
This text is formatted as if it were Java code
```

This text is formatted as if it were Java code

Doxygen Markdown

Doxygen ist ein häufig verwendetes Code-Dokumentationswerkzeug (für Sprachen wie C ++, C # und Java), das auch die Verwendung von Markdown unterstützt. Neben der Markdown-Standardsyntax gibt es eine Reihe von Doxygen-spezifischen Elementen .

Die @ref sind die Verwendung von @ref Tags für Verweise sowie die @page , @section/@subsection und @anchor , auf die sie verweisen können.

@ref <Name> ["Text"]

Dieses Element erstellt einen Link (dh einen Verweis) auf einen benannten Abschnitt, Unterabschnitt, eine Seite oder einen Anker, der an anderer Stelle in der Dokumentation definiert wurde. (siehe Doxygen-Referenz )

Der erste Parameter ( name ) sollte mit dem Namen des Abschnitts, Unterabschnitts, der Seite oder des Ankers übereinstimmen, zu dem Sie einen Link erstellen möchten.

Der zweite optionale Parameter ( "text" ) sollte in doppelte Anführungszeichen gesetzt werden und definiert, wie der Referenzlink auf der Seite erscheint. Wenn nicht verwendet, wird der Link als der in der Referenz verwendete Titel angezeigt.

@section <Abschnittsname> (Abschnittsüberschrift)

Dieses Element definiert einen Abschnittsnamen. Es entspricht visuell einem # -Element in Markdown, definiert jedoch auch eine Referenz, auf die von anderen Abschnitten Ihrer Dokumentation aus verlinkt werden kann. (siehe Doxygen-Referenz )

Der erste Parameter section-name definiert den Referenznamen, der vom @ref Element verwendet werden kann. Dies darf keine Leerzeichen enthalten.

Der section title des zweiten Parameterabschnitts ist eine Folge von Wörtern (die durch Leerzeichen getrennt werden kann), die definiert, wie die Abschnittsüberschrift auf Ihrer Seite erscheinen soll.

Beispiel

@section Intro Introduction

This is some text in my introduction.

@section Body Body Paragraph

This is some text in my body, where I refer to the @ref Intro.

Ausgabe

Einführung

Dies ist ein Text in meiner Einleitung.

Körperabschnitt

Dies ist ein Text in meinem Körper, in dem ich auf die Einleitung verweise.

Hinweis: Das Wort "Einführung" oben wird als Link angezeigt, der zur Überschrift "Einführung" führt.

GitHub Flavored Markdown

GitHub Flavored Markdown (manchmal als GFM abgekürzt) erleichtert die Arbeit mit Markdown auf GitHub.com .

Die wichtigsten Funktionen von GFM sind:

• Codeeinzug
• Unterstützung für Aufgabenlisten
• Einfache GitHub-Problemreferenzierung
• automatische GitHub-Benutzername und SHA-Erkennung
• automatische URL-Erkennung
• Emoji-Unterstützung

GFM-Beispiele

Satzstellung markieren

Mit Markdown kann ein Codeblock mit drei Backticks erzeugt werden:

```

Ohne Syntaxhervorhebung erscheint der in C geschriebene Code so

#include <stdio.h>

int main(void)
{
    printf("Hello World\n");
    return (0);
}

Doch mit Syntaxhervorhebung, Code in C geschrieben scheint wie folgt aus :

Um Code hervorzuheben, fügen Sie einfach eine optionale Sprachkennung hinzu, um die Syntaxhervorhebung in Ihrem abgeschirmten Codeblock zu aktivieren.

```C
<code text here>
```

Diese Verbesserungen dienen der Verbesserung der Dokumentations- und Konversationsqualität in README Dateien, Gists , Pull-Requests und Problemen auf der Plattform.