Markdown
Dialekty / smaki

Uwagi

Znacznik przepełnienia stosu

Jest to smak obniżki cen stosowanej przez Stack Overflow i inne strony Stack Exchange. Kiedy odpowiadasz na pytanie lub dodajesz dokumentację, używasz tego przecena. Ta odpowiedź pochodzi z obniżki SO

Zobacz oficjalną dokumentację

Główne rzeczy, które dodaje SO obniżki, znajdują się w „Dodatkach stosu wymiany” na tej stronie. W szczególności SO dodaje tagi, takie jak [tag:tag] i linki skrótów, takie jak [meta] (choć nie w dokumentach), spoilery :

To jest spoiler

>! This is a spoiler

i niestandardowe nabożeństwa w języku

<!-- 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 to powszechnie używane narzędzie do dokumentacji kodu (dla języków, w tym C ++, C # i Java), które obsługuje także Markdown. Oprócz standardowej składni Markdown istnieje wiele elementów specyficznych dla Doxygen .

Podstawowymi cechami są użycie znaczników @ref jako odniesień oraz elementy @page , @section/@subsection i @anchor , do których mogą się odwoływać.

@ref <nazwa> [„tekst”]

Ten element tworzy łącze (tj. Odwołanie) do nazwanej sekcji, podsekcji, strony lub kotwicy, która została zdefiniowana w innym miejscu w dokumentacji. (patrz odniesienie Doxygen )

Pierwszy parametr ( name ) powinien pasować do nazwy sekcji, podsekcji, strony lub kotwicy, do której chcesz utworzyć łącze.

Drugi opcjonalny parametr ( "text" ) powinien być umieszczony w podwójnych cudzysłowach i określa, jak link referencyjny pojawi się na stronie. Jeśli nie zostanie użyty, link pojawi się jako tytuł użyty w odnośniku.

@ sekcja <nazwa sekcji> (tytuł sekcji)

Ten element określa nazwę sekcji. Jest wizualnie równoważny elementowi # w Markdown, jednak zdefiniuje również odniesienie, do którego można się odsyłać z innych sekcji dokumentacji. (patrz odniesienie Doxygen )

Pierwszy parametr section-name określa section-name odwołania, której może używać element @ref . Nie może zawierać żadnych spacji.

section title drugiego parametru to ciąg słów (które można oddzielić spacjami), który określa, jak nagłówek sekcji będzie wyglądał na twojej stronie.

Przykład

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

Wynik

Wprowadzenie

To jest tekst we wstępie.

Pkt ciała

To jakiś tekst w moim ciele, w którym odnoszę się do wprowadzenia.

Uwaga: Słowo Wprowadzenie powyżej pojawi się jako link, który przejdzie do nagłówka Wprowadzenie.

GitHub Flavored Markdown

GitHub Flavored Markdown (czasami w skrócie GFM) ułatwia pracę z markdown na GitHub.com .

Kluczowe cechy GFM obejmują:

• wcięcie kodu
• obsługa listy zadań
• łatwe odwoływanie się do problemu GitHub
• automatyczne wykrywanie nazwy użytkownika GitHub i SHA
• automatyczne wykrywanie adresów URL
• obsługa emoji

Przykłady GFM

Podświetlanie składni

Dzięki Markdown blok kodu można wygenerować za pomocą trzech znaków wstecz:

```

Bez podświetlania składni kod napisany w C wygląda tak

#include <stdio.h>

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

Jednak przy podświetlaniu składni kod napisany w C wygląda następująco:

Aby podświetlić kod, wystarczy dodać opcjonalny identyfikator języka, aby włączyć podświetlanie składni w ogrodzonym bloku kodu.

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

Ulepszenia te mają na celu poprawę jakości dokumentacji i konwersacji zawartych w plikach README , listach , żądaniach ściągania i problemach na platformie.