Markdown er en letvægts og nem at bruge syntaksen for styling alle former for skrivning på GitHub platform.
Hvad du vil lære:
- Hvordan Markdown format gør stylet samarbejde redigering let
- Hvordan Markdown adskiller sig fra traditionelle formatering tilgange
- Hvordan man bruger Markdown til at formatere tekst
- Hvordan man kan udnytte GitHub automatisk Markdown rendering
- Hvordan man kan anvende GitHub unikke Markdown udvidelser
Hvad er Markdown?
Markdo .n er en måde at style tekst på nettet., Du styrer visningen af dokumentet; formatering ord som fed eller kursiv, tilføje billeder, oprette lister er blot et par af de ting, vi kan gøre med Markdown. For det meste, Markdown er blot almindelig tekst med et par ikke-alfabetiske tegn smidt i, f.eks. #
eller *
.,
Du kan bruge Markdown de fleste steder rundt omkring GitHub:
- Gists
- Kommentarer i Spørgsmål og Trække Anmodninger
- Filer
.md
eller.markdown
udvidelse
For mere information, se “Skrivning på GitHub” i GitHub Hjælp.
Eksempler
- Tekst
- Lister
- Billeder
- Overskrifter & Citater
- – Kode
- Extras
Syntaks vejledning
Her er en oversigt over Markdown syntax, som du kan bruge hvor som helst på GitHub.com eller i din egen tekst filer.,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.,kom bruger sin egen version af Markdown syntax, der giver et ekstra sæt af nyttige funktioner, der er mange, som gør det nemmere at arbejde med indhold på GitHub.com.
Bemærk, at nogle funktioner på GitHub Krydret Markdown er kun tilgængelig i de beskrivelser og kommentarer til Emner og Trække Anmodninger. Disse omfatter @mentions samt henvisninger til SHA-1 hashes, spørgsmål og Pull anmodninger. Opgavelister er også tilgængelige i Gist kommentarer og i Gist Markdo .n filer.,
Syntaks fremhævning
Her er et eksempel på, hvordan du kan bruge syntaksfremhævning med GitHub Krydret Markdown:
```javascriptfunction fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) }}```
Du kan også bare indrykning af din kode med fire rum:
function fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) } }
Her er et eksempel på en Python kode, uden syntaksfremhævning:
def foo(): if not bar: return True
huskeliste
Hvis du indeholder en liste over opgaver i den første kommentar af et Problem, du vil få en handy indikator, i dit problem liste. Det virker også i Pull anmodninger!,parating hver kolonne med en pibe |
:
Ville blive:
Første Overskrift | Anden Overskrift |
---|---|
Indhold fra celle 1 | Indhold fra celle 2 |
Indhold i den første kolonne | Indhold i anden spalte |
SHA referencer
Nogen henvisning til en commit ‘ s SHA-1 hash, vil automatisk blive konverteret til et link til at forpligte sig på GitHub.,
16c999e8c71134401a78d4d46435517b2271d6acmojombo@16c999e8c71134401a78d4d46435517b2271d6acmojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac
Spørgsmålet referencer i en database
nummer, der refererer til et Problem eller Trække Anmodning, vil automatisk blive konverteret til et hyperlink.
#1mojombo#1mojombo/github-flavored-markdown#1
Brugernavn @nævner
at Skrive en @
symbol, efterfulgt af et brugernavn, vil anmelde den pågældende person til at komme og se den kommentar. Dette kaldes en “@mention”, fordi du nævner den enkelte. Du kan også @nævne teams i en organisation.,
automatisk link til Urebadresser
enhver URL (som ) konverteres automatisk til et klikbart link.
gennemstregning
ethvert ord indpakket med to fliser (som ~~this~~
) vises krydset.
Emoji
GitHub understøtter emoji!for at se en liste over hvert billede, Vi understøtter, skal du tjekke Emoji Cheat Sheet.
Sidst opdateret 15. januar 2014