Markdown egy könnyű, könnyen használható szintaxis stílus minden formáját írásban a GitHub platform.
Mit fog tanulni:
- Hogy az Árleszállítás formátum teszi stílusú együttműködési szerkesztés könnyű
- Hogyan Árleszállítás különbözik a hagyományos formázási módszerek
- Hogyan kell használni Árleszállítás, hogy a szöveg formázása
- Hogyan használjuk a GitHub automatikus Árleszállítás renderelés
- Hogyan kell alkalmazni a GitHub egyedi Árleszállítás fájlokat
Mi az Árleszállítás?
Markdown egy módja annak, hogy Stílus szöveget az interneten., Ön irányítja a dokumentum megjelenítését; a szavak félkövér vagy dőlt formázása, Képek hozzáadása, listák létrehozása csak néhány dolog, amit a Markdown-val tehetünk. A Markdown többnyire csak szabályos szöveg, néhány nem alfabetikus karakterrel, például #
vagy *
.,
használhatja Markdown legtöbb helyen körül GitHub:
- Gists
- megjegyzések A kérdések és húzza kérések
- fájlok a
.md
vagy.markdown
kiterjesztés
további információért lásd: “írás GitHub” a GitHub segít.
Példa
- Szöveg
- Listák
- Képek
- Fejlécek & Idézetek
- Kód
- Extrák
Szintaxis útmutató
Itt egy áttekintés Árleszállítás szintaxis használható bárhol GitHub.com vagy a saját szöveges fájlok.,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.,a com a Markdown szintaxis saját verzióját használja, amely további hasznos funkciókat kínál, amelyek közül sok megkönnyíti a tartalom kezelését GitHub.com.
vegye figyelembe, hogy a GitHub ízesített Markdown néhány jellemzője csak a problémák leírásában és megjegyzéseiben, valamint a kérések Kihúzásában érhető el. Ezek közé tartozik @megemlíti, valamint utalásokat SHA-1 hash, kérdések, húzza kérések. A feladatlisták a Gist megjegyzésekben és a Gist Markdown fájlokban is elérhetők.,
Szintaxis kiemelés
Itt egy példa, hogyan lehet használni szintaxis kiemelést a GitHub Ízesített Árleszállítás:
```javascriptfunction fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) }}```
is egyszerűen bekezdés a kód négy terek:
function fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) } }
Itt egy példa Python kód nélkül szintaxis kiemelés:
def foo(): if not bar: return True
Feladat Listák
Ha tartalmazza a feladat listában az első hozzászólás egy Kérdés, kapsz egy praktikus folyamatjelző a kérdés lista. Ez is működik Pull kérések!,|
:
első fejléc | második fejléc |
---|---|
tartalom az 1.cellából | tartalom a 2. cellából |
tartalom az első oszlopban | tartalom a második oszlopban |
Sha referenciák
bármely hivatkozás a commit SHA-1 hash automatikusan átalakul egy linket, hogy kötelezzék a GitHub.,
16c999e8c71134401a78d4d46435517b2271d6acmojombo@16c999e8c71134401a78d4d46435517b2271d6acmojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac
a tárolón belüli referenciák kiadása
minden olyan szám, amely egy kérdésre vagy húzási kérésre utal, automatikusan hivatkozássá alakul.
#1mojombo#1mojombo/github-flavored-markdown#1
felhasználónév @megemlíti
gépelés egy@
szimbólum, majd egy felhasználónév, értesíti a személyt, hogy jöjjön, és tekintse meg a megjegyzést. Ez az úgynevezett “@említés”, mert te megemlíteni az egyén. Azt is @beszélve csapatok egy szervezeten belül.,
az URL-ek automatikus összekapcsolása
bármely URL (például ) automatikusan kattintható hivatkozássá alakul.
Strikethrough
bármely szó, amely két Tildával van csomagolva (például~~this~~
), áthúzva jelenik meg.
Emoji
GitHub támogatja emoji!
minden támogatott kép listájának megtekintéséhez nézze meg az Emoji Cheat lapot.
Utoljára frissítve: 2014. január 15.