Markdown
Dialects / Flavors

Anmärkningar

Stack Overflow Markdown

Detta är smaken av markdown som används av Stack Overflow och andra Stack Exchange-webbplatser. När du svarar på en fråga eller lägger till dokumentation använder du den här nedräkningen. Detta svar är gjord av SO-nedslagning

Se officiell dokumentation

De viktigaste sakerna som SO-markering lägger till är under "Stack Exchange-tillägg" på den webbsidan. Särskilt lägger SO till taggar som [tag:tag] och genvägslänkar som [meta] (men inte i dokument), spoilers :

Det här är en spoiler

>! This is a spoiler

och anpassade språkavsnitt

<!-- 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 är ett vanligt använt koddokumentationsverktyg (för språk inklusive C ++, C # och Java) som också stöder användningen av Markdown. Förutom den vanliga Markdown-syntaxen finns det ett antal Doxygen-specifika element .

De primära funktionerna är användningen av @ref taggar för referenser, och @page , @section/@subsection och @anchor som dessa kan hänvisa till.

@ref <namn> ["text"]

Detta element skapar en länk (dvs. referens) till ett namngivet avsnitt, underavsnitt, sida eller ankare som har definierats någon annanstans i dokumentationen. (se Doxygen-referens )

Den första parametern ( name ) ska matcha namnet på det avsnitt, underavsnitt, sida eller ankare som du vill länka till.

Den andra valfria parametern ( "text" ) ska vara inkapslad i dubbla citat och definierar vad referenslänken kommer att visas på sidan. Om den inte används visas länken som den titel som används i referensen.

@sektion <sektionsnamn> (avsnittets titel)

Detta element definierar ett avsnittsnamn. Det är visuellt likvärdigt med ett # -element i Markdown, men det kommer också att definiera en referens som kan kopplas till från andra delar av din dokumentation. (se Doxygen-referens )

Det första parametersektionens section-name definierar referensnamnet som kan användas av @ref elementet. Detta kan inte innehålla några mellanslag.

Den andra parameterns section title är en ordsträng (som kan separeras med mellanslag) som definierar vad avsnittrubriken ska se ut på din sida.

Exempel

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

Produktion

Introduktion

Detta är lite text i min introduktion.

Paragraf för kroppen

Detta är lite text i min kropp, där jag hänvisar till introduktionen.

OBS: Ordet Introduktion ovan kommer att visas som en länk som hoppar till rubriken Introduktion.

GitHub smaksatt markdown

GitHub Flavored Markdown (ibland förkortat till GFM) gör det lättare att arbeta med markdown på GitHub.com .

Viktiga funktioner i GFM inkluderar:

• kodindragning
• stöd för uppgiftslista
• enkel GitHub-fråga
• automatisk GitHub-användarnamn och SHA-upptäckt
• automatisk url-upptäckt
• emoji-stöd

GFM-exempel

Syntaxmarkering

Med Markdown kan ett kodblock genereras med tre backticks:

```

Utan syntaxmarkering visas kod som skrivs i C så här

#include <stdio.h>

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

Men med syntaxmarkering visas kod som skrivs i C så här:

För att markera kod lägger du bara till en valfri språkidentifierare för att aktivera syntaxmarkering i ditt inhägnade kodblock.

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

Dessa förbättringar är utformade för att förbättra kvaliteten på dokumentation och samtal som ingår i README -filer, GIST , pull förfrågningar och frågor på plattformen.