Markdown är en lätt och lättanvänd syntax för styling alla former av skrivning på GitHub-plattformen.
vad du kommer att lära dig:
- hur Markdown-formatet gör formaterad samarbetsredigering lätt
- hur Markdown skiljer sig från traditionella formateringsmetoder
- hur man använder Markdown för att formatera text
- hur man utnyttjar GitHubs automatiska Markdown-rendering
- hur man applicerar GitHubs unika Markdown-tillägg
Vad är Markdown?
Markdown är ett sätt att formatera text på webben., Du styr visningen av dokumentet; formatera ord som fet eller kursiv, lägga till bilder och skapa listor är bara några av de saker vi kan göra med Markdown. För det mesta är Markdown bara vanlig text med några icke-alfabetiska tecken som kastas in, som #
eller *
.,
Du kan använda Markdown de flesta platser runt GitHub:
- Gists
- kommentarer i frågor och dra förfrågningar
- filer med
.md
eller.markdown
förlängning
För mer information, se ”Skriva på GitHub” i GitHub hjälp.
exempel
- Text
- listor
- bilder
- rubriker & citat
- kod
- extramaterial
Syntaxguide
här är en översikt över Markdown syntax som du kan använda var som helst på GitHub.com eller i dina egna textfiler.,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 använder sin egen version av Markdown syntax som ger en extra uppsättning användbara funktioner, varav många gör det lättare att arbeta med innehåll på GitHub.com.
Observera att vissa funktioner i Github Flavored Markdown endast är tillgängliga i Beskrivningar och kommentarer av problem och Pull-förfrågningar. Dessa inkluderar @mentions samt referenser till SHA-1-hashar, problem och Pull-förfrågningar. Uppgiftslistor finns också i Gist kommentarer och i Gist Markdown filer.,
syntaxmarkering
här är ett exempel på hur du kan använda syntaxmarkering med Github Flavored Markdown:
```javascriptfunction fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) }}```
Du kan också helt enkelt dra in din kod med fyra mellanslag:
function fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) } }
här är ett exempel på Python-kod utan syntaxmarkering:
def foo(): if not bar: return True
uppgiftslistor
om du inkluderar en uppgiftslista i den första kommentaren av ett problem får du en praktisk framstegsindikator i din problemlista. Det fungerar också I Pull förfrågningar!,paraterar varje kolumn med ett rör |
:
skulle bli:
första rubrik | andra rubrik |
---|---|
innehåll från cell 1 | innehåll från cell 2 |
innehåll i den första kolumnen | innehåll i den andra kolumnen |
sha referenser
någon hänvisning till en commit s SHA-1 hash kommer automatiskt att omvandlas till en länk till att begå på GitHub.,
16c999e8c71134401a78d4d46435517b2271d6acmojombo@16c999e8c71134401a78d4d46435517b2271d6acmojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac
utfärda referenser i ett förråd
ett nummer som refererar till ett problem eller Pull-förfrågan kommer automatiskt att konverteras till en länk.
#1mojombo#1mojombo/github-flavored-markdown#1
användarnamn @mentions
skriva en@
symbol, följt av ett användarnamn, kommer att meddela den personen att komma och visa kommentaren. Detta kallas en ”@omnämnande”, eftersom du nämner individen. Du kan också @ nämna lag inom en organisation.,
automatisk länkning för webbadresser
alla webbadresser (som) kommer automatiskt att konverteras till en klickbar länk.
genomslag
alla ord som är inslagna med två plattor (som~~this~~
) kommer att visas överkorsade.
Emoji
GitHub stöder emoji!
för att se en lista över varje bild Vi stöder, kolla in Emoji Cheat Sheet.
Senast uppdaterad 15 Jan 2014