Perus kirjoittaminen ja muotoilu syntaksi

Otsikot

Voit luoda nimike, lisää yksi kuusi # symbolit, ennen kuin otsikon teksti. # käyttämäsi määrä määrittää nimikkeen koon.

# The largest heading## The second largest heading###### The smallest heading

Muotoilu tekstiä

Voit osoittaa huomiota rohkea, kursivoitu, tai yliviivattu teksti.

siteeraa tekstiä

voit lainata tekstiä >.,

In the words of Abraham Lincoln:> Pardon my French

siteeraa koodia

voit huutaa koodin tai komennon lauseen sisällä yksittäisillä takakannoilla. Takatikkujen sisällä olevaa tekstiä ei alusteta.,

Use `git status` to list all new or modified files that haven't yet been committed.

muotoile koodi tai teksti oma erillinen lohko, käyttää triple backticks.

Some basic Git commands are:```git statusgit addgit commit```

lisätietoja, katso ”Luomalla ja korostamalla koodi lohkoja.”

Linkit

Voit luoda inline-linkin kietomalla linkin teksti suluissa , ja sitten kääre URL-osoite perään sulkeissa ( ). Linkin luomiseen voi käyttää myös näppäimistön pikakuvaketta command + k.,

This site was built using (https://pages.github.com/).

– Osioon linkkejä

Voit linkittää suoraan osioon sulatettu tiedosto leijuu kohta menossa paljastaa linkki:

Suhteellisia linkkejä

Voit määrittää suhteellisia linkkejä ja kuvan polkuja sulatettu tiedostoja, auttaa lukijoita navigoimaan muita tiedostoja arkistoon.,

suhteellinen linkki on linkki, joka on suhteessa nykyiseen tiedostoon. Esimerkiksi, jos sinulla on README-tiedosto juureen arkiston, ja sinulla on toinen tiedoston docs/EDISTÄÄ.md, suhteellinen linkki OSALTAAN.md oman LUEMINUT-tiedosto voisi näyttää tältä:

(docs/CONTRIBUTING.md)

GitHub automaattisesti muuntaa suhteellinen linkki tai kuvan polku perusteella, mitä haara olet tällä hetkellä, niin että linkki tai polku toimii aina. Voit käyttää suhteellista linkkiä operandit, esimerkiksi ./ ja ../.,

suhteelliset linkit ovat helpompia käyttäjille, jotka kloonaavat arkistosi. Absoluuttiset linkit eivät välttämättä toimi arkistosi klooneissa – suosittelemme suhteellisten linkkien käyttämistä viittaamaan muihin arkistosi tiedostoihin.

Luettelot

Voit tehdä järjestämätön lista edeltävän yhden tai useamman riviä tekstiä - tai *.

- George Washington- John Adams- Thomas Jefferson

tilata luettelon, kirjoita kukin rivi, jossa on numero.,

1. James Madison2. James Monroe3. John Quincy Adams

Sisäkkäiset Luettelot

Voit luoda sisäkkäisiä listan sisennys yksi tai useampi lista kohteita alla toinen erä.

luodaksesi sisäkkäisen luettelon käyttämällä GitHubin verkkoeditoria tai monospaced-kirjasinta käyttävää tekstieditoria, kuten atomia, voit yhdenmukaistaa listasi visuaalisesti. Tilaa tyyppi merkkiä edessä sisäkkäisiä listan alkion, kunnes listan merkki-merkki (- tai *) sijaitsee suoraan alapuolella ensimmäinen merkki tekstin kohteen yläpuolella.,

1. First list item - First nested list item - Second nested list item

Voit luoda sisäkkäisiä luettelo kommentti-toimittaja GitHub, joka ei käytä tasavälistä fonttia, voit tarkastella luetteloa kohteen välittömästi yläpuolella sisäkkäisiä luettelo ja laskea määrän merkkejä, jotka näkyvät ennen alkion sisällön. Kirjoita sitten tämä määrä tilaa merkkiä edessä sisäkkäisen luettelon kohde.,

tässä esimerkissä, voit lisätä sisäkkäisiä luettelo nimikkeen alla lista kohde 100. First list item sisennys, jonka sisäkkäisiä listan kohde vähintään viisi tiloihin, koska siellä on viisi merkkiä () ennen First list item.

100. First list item - First nested list item

Voit luoda useita tasolla sisäkkäisiä luetteloita käyttämällä samaa menetelmää., Esimerkiksi, koska ensimmäinen sisäkkäisiä listan kohde on seitsemän tilat (␣␣␣␣␣-␣), ennen kuin sisäkkäisiä listan sisältöä First nested list item, sinun täytyy luetelmakohta toisen sisäkkäisen luettelon kohta seitsemän tiloihin.

100. First list item - First nested list item - Second nested list item

lisää esimerkkejä, katso GitHub Maustettu Markdown Spec.

tehtävälistat

Voit luoda tehtäväluettelon, esipuhe luettelon kohteet, joissa on tavallinen välilyönti, jota seuraa . Merkitäkseen tehtävän täydelliseksi, käytä .,

- Finish my changes- Push my commits to GitHub- Open a pull request

Jos tehtävä luettelo kohteen kuvaus alkaa suluissa, sinun täytyy paeta sitä \:

- \(Optional) Open a followup issue

lisätietoja katso ”Tietoja-tehtäväluettelot.”

Mainita, ihmiset ja joukkueet

Voit mainita henkilön tai ryhmän GitHub kirjoittamalla @ plus käyttäjätunnus tai joukkueen nimi. Tämä käynnistää ilmoituksen ja tuo heidän huomionsa keskusteluun., Ihmiset saavat myös ilmoituksen, jos muokkaat kommenttia mainiten heidän käyttäjätunnuksensa tai joukkueen nimen. Lisätietoja ilmoituksista on kohdassa ” ilmoitukset.”

@github/support What do you think about these updates?

Kun mainitaan vanhemman tiimin jäsenet sen lapsen joukkueet saavat myös ilmoituksia, yksinkertaistaa viestintää, jossa on useita ryhmiä. Lisätietoja on kohdassa ” Tietoa joukkueista.”

@ symboli nostaa esiin listan ihmisistä tai tiimeistä projektissa., Luettelo suodattimet kuten tyyppi, joten kun löydät henkilön nimi tai joukkue etsit, voit käyttää nuolinäppäimillä valitse se ja paina joko sarkain-tai enter-täydellinen nimi. Tiimeille, Kirjoita @organisaatio / team-nimi ja kaikki jäsenet, että joukkue saa tilattu keskusteluun.

automaattitäydennystulokset rajoittuvat arkistoyhteistyökumppaneihin ja muihin langalla oleviin osallistujiin.

Vertailemalla kysymyksiä ja vetää pyynnöt

Voit tuoda luettelon ehdotti kysymyksiä ja vetää pyynnöt arkistosta kirjoittamalla #., Kirjoita kysymys tai vedä pyyntönumero tai otsikko suodattaa luettelon, ja paina sitten joko välilehti tai anna loppuun valitun tuloksen.

lisätietoja on ohjeissa ”Autolinked references and URLs.”

Vertailemalla ulkoisia resursseja

Jos custom autolink viittaukset ovat määritetty varasto, sitten viittaukset ulkoisia resursseja, kuten JIRA kysymys tai Zendesk lippu, muuntaa lyhentää linkkejä. Jos haluat tietää, mitkä autolinkit ovat versiovarastossasi, ota yhteys johonkin, jolla on järjestelmänvalvojan oikeudet arkistoon., Lisätietoja on kohdassa ” Autolinkkien määrittäminen ulkoisten resurssien käyttöä varten.”

Sisältöliitteet

jotkut GitHub-sovellukset antavat GitHubissa tietoja URL-osoitteista, jotka linkittyvät niiden rekisteröityihin verkkotunnuksiin. GitHub antaa sovelluksen toimittamat tiedot URL-osoitteen alla ongelman tai pull-pyynnön yhteydessä.

sisältöä liitetiedostoja, sinun täytyy olla GitHub App, joka käyttää Sisältöä Liitteet API asennettu arkistoon., Lisätietoja: ”sovelluksen asentaminen henkilökohtaiselle tilillesi” ja ”sovelluksen asentaminen organisaatioosi.”

Sisältö liitteitä ei näytetä Url-osoitteita, jotka ovat osa markdown-linkkiä.

lisätietoa sisällysliitteitä käyttävän GitHub-sovelluksen rakentamisesta on kohdassa ”Using Content Attachments.”

Käyttämällä emoji

Voit lisätä emoji kirjoittamista kirjoittamalla :EMOJICODE:.

@octocat :+1: This PR looks great - it's ready to merge! :shipit:

Kirjoittaminen : tuo esiin luettelon ehdotti emoji., Luettelo suodattaa kun kirjoitat, joten kun löydät emoji etsit, paina välilehti tai kirjoita loppuun korostetun tuloksen.

täydellinen luettelo saatavilla olevista emojeista ja koodeista, katso Emoji-huijausarkki.

Edellä

Voit luoda uuden kohdan jättämällä tyhjä rivi riviä tekstiä.

Välittämättä Markdown muotoilua

Voit kertoa GitHub sivuuttaa (tai paeta) Markdown muotoilua käyttämällä \ ennen Markdown luonne.,

Let's rename \*our-new-project\* to \*our-old-project\*.

lisätietoja Daring Fireball ”Markdown Syntaksin.”

kirjallisuutta

• GitHub Maustettu Markdown Spec
• ”Tietoja kirjoittaminen ja muotoilu GitHub”
• ”advanced muotoilu”
• ”Mastering Markdown”