Markdown
Dialecten / Flavors

Opmerkingen

Stack Overflow Markdown

Dit is de smaak van markdown die wordt gebruikt door Stack Overflow en andere Stack Exchange-sites. Wanneer u een vraag beantwoordt of documentatie toevoegt, gebruikt u deze markdown. Dit antwoord is gemaakt van SO markdown

Zie officiële documentatie

De belangrijkste dingen die SO markdown toevoegt, zijn onder "Stack Exchange-toevoegingen" op die webpagina. SO voegt met name tags toe zoals [tag:tag] en snelkoppelingen zoals [meta] (niet in documenten), spoilers :

Dit is een spoiler

>! This is a spoiler

en aangepaste taaltoewijzingen

<!-- 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 is een veelgebruikte codedocumentatie- tool (voor talen zoals C ++, C # en Java) die ook het gebruik van Markdown ondersteunt. Naast de standaard Markdown-syntaxis zijn er een aantal Doxygen-specifieke elementen .

De primaire functies zijn het gebruik van @ref tags voor referenties en de elementen @page , @section/@subsection en @anchor waarnaar deze kunnen verwijzen.

@ref <naam> ["tekst"]

Dit element maakt een koppeling (bijv. Verwijzing) naar een benoemde sectie, subsectie, pagina of anker die elders in de documentatie is gedefinieerd. (zie referentie naar zuurstof )

De eerste parameter ( name ) moet overeenkomen met de naam van de sectie, subsectie, pagina of anker waarnaar u wilt linken.

De tweede optionele parameter ( "text" ) moet worden ingekapseld in dubbele aanhalingstekens en bepalen hoe de referentielink op de pagina wordt weergegeven. Indien niet gebruikt, zal de link verschijnen als de titel die in de referentie wordt gebruikt.

@section <section-name> (sectietitel)

Dit element definieert een sectienaam. Het is visueel equivalent aan een # -element in Markdown, maar het zal ook een verwijzing definiëren waarnaar kan worden gelinkt vanuit andere secties van uw documentatie. (zie referentie naar zuurstof )

De eerste parameter section-name definieert de referentienaam die door het element @ref kan worden gebruikt. Dit mag geen spaties bevatten.

De tweede section title parametersectie is een reeks woorden (die door spaties kunnen worden gescheiden) die bepaalt hoe de sectiekop op uw pagina wordt weergegeven.

Voorbeeld

@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.

uitgang

Invoering

Dit is wat tekst in mijn inleiding.

Paragraaf van het lichaam

Dit is wat tekst in mijn lichaam, waar ik naar de inleiding verwijs.

NB: het woord Introductie hierboven zal verschijnen als een link die naar de kop Introductie zal springen.

GitHub Flavoured Markdown

GitHub Flavoured Markdown (soms afgekort tot GFM) maakt het gemakkelijker om met markdown op GitHub.com te werken .

Belangrijkste kenmerken van GFM zijn:

• code inspringen
• ondersteuning takenlijst
• eenvoudige GitHub-probleemreferentie
• automatische GitHub-gebruikersnaam en SHA-detectie
• automatische url-detectie
• emoji-ondersteuning

GFM-voorbeelden

Syntaxis markeren

Met Markdown kan een codeblok worden gegenereerd met drie backticks:

```

Zonder syntaxisaccentuering ziet code die in C is geschreven er zo uit

#include <stdio.h>

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

Echter, met syntax highlighting, code geschreven in C er als volgt uitziet:

Om code te markeren, voegt u eenvoudig een optionele taal-ID toe om syntax markering in uw omheinde codeblok in te schakelen.

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

Deze verbeteringen zijn ontworpen om de kwaliteit van de documentatie en conversatie opgenomen in het verbeteren van README bestanden, GISTen , pull verzoeken en problemen op het platform.