Markdown er et lett og lett-å-bruke syntaks for styling av alle former for skriftlig på GitHub-plattformen.
Hva du vil lære:
- Hvordan Markdown format gjør stylet samarbeidende redigering lett
- Hvordan Markdown skiller seg fra tradisjonell formatering tilnærminger
- Hvordan å bruke Markdown å formatere tekst
- Hvordan å utnytte GitHub er Markdown automatisk gjengivelse
- Hvordan å bruke GitHub unike Markdown utvidelser
Hva er Markdown?
Markdown er en måte å style tekst på internett., Du styrer visningen av dokumentet; formatering ord som fet eller kursiv, legge til bilder, og lage lister er bare noen av tingene vi kan gjøre med Markdown. For det meste, Markdown er bare vanlig tekst med et par ikke-alfabetiske tegn kastet i, som #
eller *
.,
Du kan bruke Markdown de fleste steder rundt på GitHub:
- Gists
- Kommentarer i Problemer og Trekk Forespørsler
- Filer med
.md
eller.markdown
extension
For mer informasjon, se «Skrive på GitHub» i GitHub Hjelp.
Eksempler på
- Tekst
- Viser
- Bilder
- Overskrifter & Sitater
- – Koden
- Tilbehør
Syntaks guide
Her er en oversikt over Markdown syntaks som du kan bruke 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.,com bruker sin egen versjon av Markdown syntaks som gir et ekstra sett med nyttige funksjoner, og mange av dem gjør det enklere å jobbe med innhold på GitHub.com.
vær Oppmerksom på at enkelte funksjoner på GitHub Flavored Markdown er kun tilgjengelig i beskrivelser og kommentarer om Problemer og Trekk Forespørsler. Disse inkluderer @nevner, samt referanser til SHA-1-hasher, Problemer, og Trekk Forespørsler. Oppgaven Lister er også tilgjengelig i Hovedpunkt kommentarer og Hovedpunkt i Markdown-filer.,
Syntaks utheving
Her er et eksempel på hvordan du kan bruke syntaks-utheving med GitHub Flavored Markdown:
```javascriptfunction fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) }}```
Du kan også bare rykke inn din kode på fire områder:
function fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) } }
Her er et eksempel av Python-kode uten syntaks utheving:
def foo(): if not bar: return True
oppgavelister
Hvis du inkluderer en oppgave liste i første kommentar på et Problem, du vil få en praktisk fremgang indikatoren i problemet listen. Det fungerer også i Trekk Forespørsler!,parating hver kolonne med en pipe |
:
Ville bli:
Første Overskrift | Andre Overskrift |
---|---|
Innhold fra celle 1 | Innhold celle 2 |
Innhold i den første kolonnen | Innhold i den andre kolonnen |
SHA referanser
Enhver referanse til en commit ‘ s SHA-1 hash vil automatisk bli omgjort til en link til som gjer på GitHub.,
16c999e8c71134401a78d4d46435517b2271d6acmojombo@16c999e8c71134401a78d4d46435517b2271d6acmojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac
Problemet referanser innen en depotet
Noen tall som refererer til et Problem eller Trekke Forespørsel vil automatisk bli omgjort til en link.
#1mojombo#1mojombo/github-flavored-markdown#1
Brukernavn @nevner
å Skrive en @
symbol, etterfulgt av brukernavn, vil underrette vedkommende til å komme og vise kommentar. Dette kalles en «@nevne», fordi du er å nevne den enkelte. Du kan også @nevne lagene i en organisasjon.,
Automatisk kobling for Nettadresser
Noen URL-adresse (som ) vil automatisk bli konvertert til en klikkbar lenke.
Gjennomstreking
Noen ord pakket med to tilder (som ~~this~~
) vises krysset ut.
Emoji
GitHub støtter emoji!
for Å se en liste over alle bildene vi støtter, sjekk ut Emoji Jukse Ark.
Sist oppdatert Jan 15, 2014