Markdown
Dialetti / Sapori

Osservazioni

Markdown overflow dello stack

Questo è il sapore del markdown utilizzato da Stack Overflow e altri siti Stack Exchange. Quando rispondi a una domanda o aggiungi la documentazione, usi questo markdown. Questa risposta è fatta da SO markdown

Vedi la documentazione ufficiale

Le cose principali aggiunte da SO markdown si trovano sotto "Stack Exchange additions" su quella pagina web. In particolare, SO aggiunge tag come [tag:tag] e link di scelta rapida come [meta] (non in docs però), spoiler :

Questo è uno spoiler

>! This is a spoiler

e le devozioni linguistiche personalizzate

<!-- 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 è uno strumento di documentazione del codice comunemente usato (per le lingue tra cui C ++, C # e Java) che supporta anche l'uso di Markdown. Oltre alla sintassi standard di Markdown, vi sono numerosi elementi specifici di Doxygen .

Le caratteristiche principali sono l'uso dei tag @ref per i riferimenti e gli elementi @page , @section/@subsection e @anchor cui questi possono fare riferimento.

@ref <nome> ["testo"]

Questo elemento crea un collegamento (es. Riferimento) a una sezione, sottosezione, pagina o ancora denominata che è stata definita altrove nella documentazione. (vedi riferimento a Doxygen )

Il primo parametro ( name ) deve corrispondere al nome della sezione, sottosezione, pagina o ancora a cui si desidera collegare.

Il secondo parametro opzionale ( "text" ) dovrebbe essere incapsulato tra virgolette doppie e definirà quale sarà il collegamento di riferimento che apparirà come nella pagina. Se non utilizzato, il collegamento apparirà come titolo utilizzato nel riferimento.

@section <nome-sezione> (titolo della sezione)

Questo elemento definisce un nome di sezione. È visivamente equivalente a un elemento # in Markdown, tuttavia definirà anche un riferimento che può essere collegato da altre sezioni della documentazione. (vedi riferimento a Doxygen )

Il primo parametro section-name definisce il nome di riferimento che può essere utilizzato dall'elemento @ref . Questo non può contenere spazi.

Il secondo section title parametri è una stringa di parole (che può essere separata da spazi) che definisce quale sarà l'intestazione della sezione sulla tua pagina.

Esempio

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

Produzione

introduzione

Questo è un testo nella mia introduzione.

Corpo Paragrafo

Questo è un testo nel mio corpo, in cui mi riferisco all'introduzione.

NB: la parola Introduzione sopra apparirà come un collegamento che salterà all'intestazione Introduzione.

GitHub Flavored Markdown

GitHub Flavored Markdown (a volte abbreviato in GFM) rende più facile lavorare con il markdown su GitHub.com .

Le caratteristiche principali di GFM includono:

• indentazione del codice
• supporto elenco attività
• facile riferimento al problema con GitHub
• nome utente GitHub automatico e rilevamento SHA
• rilevamento automatico dell'URL
• supporto per le emoji

Esempi GFM

Evidenziazione della sintassi

Con Markdown, un blocco di codice può essere generato con tre apici inversi:

```

Senza l'evidenziazione della sintassi, il codice scritto in C appare in questo modo

#include <stdio.h>

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

Tuttavia, con l' evidenziazione della sintassi, il codice scritto in C appare in questo modo:

Per evidenziare il codice, è sufficiente aggiungere un identificatore di lingua opzionale per abilitare l'evidenziazione della sintassi nel blocco di codice recintato.

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

Questi miglioramenti sono progettati per migliorare la qualità della documentazione e della conversazione inclusi nei file README , negli elenchi , nelle richieste di pull e nei problemi sulla piattaforma.