Markdown è una sintassi leggera e facile da usare per lo styling di tutte le forme di scrittura sulla piattaforma GitHub.
che Cosa si impara:
- Come formato Markdown rende in stile collaborativo editing facile
- Come Markdown si differenzia dalle tradizionali formattazione approcci
- Come utilizzare Markdown formattazione del testo
- Come sfruttare GitHub automatico Markdown rendering
- Come applicare GitHub unico Markdown estensioni
che Cosa è Markdown?
Markdown è un modo per modellare il testo sul web., È possibile controllare la visualizzazione del documento; formattazione parole in grassetto o corsivo, l’aggiunta di immagini, e la creazione di elenchi sono solo alcune delle cose che possiamo fare con Markdown. Per lo più, Markdown è solo un testo normale con alcuni caratteri non alfabetici inseriti, come #
o *
.,
È possibile utilizzare Markdown maggior parte dei luoghi in tutto GitHub:
- Gist
- Commenti in Problemi e Tirare le Richieste
- i File con
.md
o.markdown
estensione
Per ulteriori informazioni, vedere “Scrittura su GitHub” in GitHub Aiuto.
Esempi
- Testo
- Liste
- Immagini
- Header & Quotazioni
- Codice
- Extra
Sintassi guida
Ecco una panoramica di sintassi Markdown, che è possibile utilizzare in qualsiasi punto GitHub.com o nel tuo file di testo.,3>Headers
# This is an <h1> tag## This is an <h2> tag###### This is an <h6> tag
Emphasis
*This text will be italic*_This will also be italic_**This text will be bold**__This will also be bold___You **can** combine them_
Lists
Unordered
* Item 1* Item 2 * Item 2a * Item 2b
Ordered
1. Item 11. Item 21. Item 3 1. Item 3a 1. Item 3b
Images
!(/images/logo.png)Format: !(url)
Links
http://github.com - automatic!(http://github.com)
Blockquotes
As Kanye West said:> We're living the future so> the present is our past.
Inline code
I think you should use an`<addr>` element here instead.
GitHub Flavored Markdown
GitHub.,com utilizza la propria versione della sintassi Markdown che fornisce un ulteriore set di funzioni utili, molte delle quali rendono più facile lavorare con i contenuti su GitHub.com.
Si noti che alcune funzionalità di GitHub Flavored Markdown sono disponibili solo nelle descrizioni e nei commenti di Problemi e richieste di Pull. Questi includono @ menzioni e riferimenti a hash SHA-1, Problemi e richieste di pull. Gli elenchi di attività sono disponibili anche nei commenti Gist e nei file Gist Markdown.,
evidenziazione della Sintassi
Ecco un esempio di come è possibile utilizzare l’evidenziazione della sintassi con GitHub Aromatizzato Markdown:
```javascriptfunction fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) }}```
Si può anche semplicemente rientrare il codice da quattro spazi:
function fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) } }
Ecco un esempio di codice Python senza evidenziazione della sintassi:
def foo(): if not bar: return True
Elenchi di Attività
Se si include un elenco di attività nel primo commento di un Problema, si ottiene un pratico indicatore di avanzamento nel tuo elenco problemi. Funziona anche nelle richieste di pull!,pa rating per ciascuna colonna, con un tubo |
:
diventa:
Intestazione di Prima | Secondo Intestazione |
---|---|
Contenuto di una cella 1 | Contenuto di una cella 2 |
Contenuto nella prima colonna | Contenuto nella seconda colonna |
SHA riferimenti
Ogni riferimento a commettere l’hash SHA-1 verrà convertito automaticamente in un link che si impegnano su GitHub.,
16c999e8c71134401a78d4d46435517b2271d6acmojombo@16c999e8c71134401a78d4d46435517b2271d6acmojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac
Riferimenti a un problema all’interno di un repository
Qualsiasi numero che fa riferimento a un Problema o a una Richiesta di Pull verrà automaticamente convertito in un collegamento.
#1mojombo#1mojombo/github-flavored-markdown#1
Username @mentions
Digitando un simbolo @
, seguito da un nome utente, notificherà a quella persona di venire a visualizzare il commento. Questo è chiamato “@ mention”, perché stai menzionando l’individuo. Puoi anche @ menzionare i team all’interno di un’organizzazione.,
Collegamento automatico per URL
Qualsiasi URL (come) verrà automaticamente convertito in un link cliccabile.
Barrato
Qualsiasi parola avvolta con due tilde (come~~this~~
) apparirà barrato.
Emoji
GitHub supporta emoji!
Per vedere un elenco di ogni immagine che supportiamo, controlla il Cheat Sheet Emoji.
Ultimo aggiornamento 15 gennaio 2014