Markdown on kevyt ja helppo käyttää syntaksi muotoilu kaikenlainen kirjoittaminen GitHub-alustalla.
Mitä opit:
- Miten Markdown-muodossa tekee tyylistä yhteistyössä editointi helppoa
- Miten Markdown eroaa perinteisen muotoilun lähestymistavat
- Kuinka käyttää Markdown-muodossa tekstiä
- Miten hyödyntää GitHub on automaattinen Markdown mallinnus
- Miten soveltaa GitHub on ainutlaatuinen Markdown laajennukset
Mikä on Markdown?
Markdown on tapa tyylitellä tekstiä netissä., Ohjaat asiakirjan näyttämistä; sanojen muotoilu lihavoituna tai kursivoituna, kuvien lisääminen ja luetteloiden luominen ovat vain muutamia asioita, joita voimme tehdä markdownin kanssa. Enimmäkseen, Markdown on vain tavallisen tekstin kanssa, muutama ei-kirjaimia heitetty, kuten #
tai *
.,
Voit käyttää Markdown useimmissa paikoissa noin GitHub:
- Sisältö
- Kommentit Kysymyksiä ja Vetää Pyynnöt
- Tiedostoja
.md
tai.markdown
laajennus
lisätietoja katso ”Kirjoittaminen GitHub” GitHub Auttaa.
Esimerkkejä
- Tekstiä
- Luettelot
- Kuvia
- Otsikot & Lainauksia
- Koodi
- Ekstrat
Syntaksin opas
Tässä on yleiskatsaus siitä, Markdown syntaksi, jota voit käyttää missä tahansa GitHub.com tai oma teksti-tiedostoja.,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 käyttää oma versio Markdown syntaksin, joka tarjoaa muita hyödyllisiä ominaisuuksia, joista monet tehdä se helpompi työskennellä sisältöä GitHub.com.
Huomaa, että jotkin ominaisuudet GitHub Maustettu Markdown ovat saatavilla vain kuvauksia ja kommentteja, Kysymyksiä ja Vetää Pyyntöjä. Näihin kuuluvat @ – maininnat sekä viittaukset SHA-1-hasheihin, kysymyksiin ja Pull-pyyntöihin. Tehtävälistat ovat saatavilla myös Gist-kommenteissa ja Gist Markdown-tiedostoissa.,
Syntaksin korostus
Tässä on esimerkki siitä, miten voit käyttää syntaksin kanssa GitHub Maustettu Markdown:
```javascriptfunction fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) }}```
Voit myös yksinkertaisesti luetelmakohta koodin neljä tilat:
function fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) } }
Tässä on esimerkki Python-koodi ilman syntaksin korostus:
def foo(): if not bar: return True
tehtävälistat
Jos lisäät tehtävän luettelon ensimmäinen kommentti aiheesta: saat kätevä edistymisen ilmaisin oman kysymys-luettelosta. Se toimii myös Vetopyynnöissä!,parating kunkin sarakkeen putki |
:
Olisi tullut:
Ensimmäinen Otsikko | Toinen Otsikko |
---|---|
Sisältö solusta 1 | Sisältö solusta 2 |
Sisältö ensimmäinen sarake | Sisältö toisen sarakkeen |
SHA viittauksia
Kaikki viittaukset commit on SHA-1 hash muunnetaan automaattisesti linkin, että sitoutua GitHub.,
16c999e8c71134401a78d4d46435517b2271d6acmojombo@16c999e8c71134401a78d4d46435517b2271d6acmojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac
Kysymys viittaukset arkiston sisällä
mikä Tahansa numero, joka viittaa Ongelman, tai Vetämään Pyyntö muunnetaan automaattisesti linkin.
#1mojombo#1mojombo/github-flavored-markdown#1
Käyttäjätunnus @mainitsee
kun Kirjoitat @
symboli, jonka jälkeen käyttäjätunnus, ilmoittaa, että henkilö tule ja näytä kommentti. Tätä kutsutaan ”@ – maininnaksi”, koska mainitset yksilön. Voit myös @ mainita tiimit organisaation sisällä.,
Automaattinen linkitys Url
mitä Tahansa URL-osoite (kuten ) muunnetaan automaattisesti klikattava linkki.
Yliviivattu
mikä Tahansa sana kääritty kaksi tildes (kuten ~~this~~
) näkyy yliviivattuna.
Emoji
GitHub tukee emojeja!
Katso lista jokaisesta tukemastamme kuvasta, Katso Emoji-huijausarkki.
päivitetty viimeksi 15. tammikuuta 2014