Grunnleggende skriving og formatering syntaks

Overskrifter

for Å lage en overskrift, legge til én til seks # symboler før kursen tekst. Antall # du bruker vil avgjøre størrelsen på overskriften.

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

Styling tekst

Du kan angi vekt med fet, kursiv, eller gjennomstreket tekst.

Sitere tekst

Du kan sitere tekst med en >.,

In the words of Abraham Lincoln:> Pardon my French

Sitere kode

Du kan ringe ut-kode eller en kommando i en setning med enkelt backticks. Teksten i backticks vil ikke bli formatert.,

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

for Å format kode eller tekst til sin egen distinkte blokkere trippel backticks.

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

For mer informasjon, se «Opprette og fremheve kode blokker.»

Lenker

Du kan opprette en direkte kobling ved å pakke link tekst i parentes , og deretter pakke-URL-en i parentes ( ). Du kan også bruke hurtigtasten command + k for å opprette en kobling.,

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

– Delen av koblinger

Du kan lenke direkte til en seksjon i en gjengis fil ved å holde musepekeren over den delen som er på vei til utsett link:

Relative lenker

Du kan angi relativ linker og bilde stier i din gjengitt filer for å hjelpe lesere til å navigere til de andre filene i depotet.,

En relativ link er en link som er i forhold til den gjeldende filen. For eksempel, hvis du har en README-fil i roten av depotet, og du har en annen fil i docs/BIDRA.md, er den relative link til å BIDRA.md i README kan se ut som dette:

(docs/CONTRIBUTING.md)

GitHub vil automatisk forvandle din relative link eller bilde vei, basert på uansett hvilken gren du er for øyeblikket på, slik at koblingen eller banen alltid fungerer. Du kan bruke alle forhold link operander, for eksempel ./ og ../.,

Relative lenker er lettere for brukere som klone depotet. Absolutt koblinger ikke fungerer i kloner av depotet – vi anbefaler å bruke relative lenker for å se andre filene i depotet.

Viser

Du kan lage en liste i tilfeldig rekkefølge av de foregående én eller flere linjer med tekst med - eller *.

- George Washington- John Adams- Thomas Jefferson

for Å bestille din liste, foran hver linje med et nummer.,

1. James Madison2. James Monroe3. John Quincy Adams

Nestede Lister

Du kan opprette en kjedet liste ved innrykk av ett eller flere listeelementer under et annet element.

for Å lage en kjedet liste ved å bruke web editor på GitHub eller en tekst editor som bruker en monospace skrifttype, som Atom, kan du justere listen visuelt. Skriv inn mellomrom i front av nestede listen element til listen markør tegn (- eller *) ligger rett nedenfor det første tegnet i teksten i objektet over det.,

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

for Å lage en kjedet liste i kommentar-redaktør på GitHub, som ikke bruker en monospace skrifttype, du kan se på listen varen umiddelbart over den nestede liste og telle antall tegn som vises før innholdet av elementet. Skriv deretter inn det antall mellomrom foran neste elementet.,

I dette eksempelet, kan du legge til en nestet i listen under listen elementet 100. First list item ved innrykk av den nestede listeelement et minimum av fem områder, siden det er fem tegn () før First list item.

100. First list item - First nested list item

Du kan opprette flere nivåer av nestede lister ved hjelp av samme metode., For eksempel, fordi den første nestede listen element har sju områder (␣␣␣␣␣-␣) før den nestede listen innhold First nested list item, er du nødt til å rykke inn den andre nestede listen element av syv områder.

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

For flere eksempler, se GitHub Flavored Markdown Spec.

oppgavelister

for Å opprette en oppgaveliste, forord liste elementer med jevne mellomrom etterfulgt av . Hvis du vil merke en oppgave som fullført, kan du bruke .,

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

Hvis en oppgave liste-element beskrivelse begynner med en parentes, du trenger for å flykte fra det med \:

- \(Optional) Open a followup issue

For mer informasjon, se «Om oppgaven lister.»

å Nevne utvikler mennesker og team

Du kan nevne en person eller et team på GitHub ved å skrive @ pluss brukernavn eller navn på laget. Dette vil utløse en melding og få deres oppmerksomhet til samtale., Folk vil også motta en melding hvis du vil redigere en kommentar for å nevne sitt brukernavn eller navn på laget. For mer informasjon om varsler, se Om varsler.»

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

Når du nevner en forelder team, medlemmer av sine barn lagene også motta varsler, forenkle kommunikasjon med flere grupper av mennesker. For mer informasjon, se «Om lagene.»

å Skrive en @ symbolet vil du få opp en liste over personer eller grupper på et prosjekt., Listen filtreres mens du skriver, slik at når du finner navnet på personen eller gruppen du er ute etter, kan du bruke piltastene til å velge den og trykke på enten tab eller enter for å fullføre navnet. For lag, skriv @organisasjon/team-navn og alle medlemmer av teamet vil få abonnerer på samtale.

autofullfør resultatene er begrenset til depotet, samarbeidspartnere og alle andre deltakere på tråden.

Refererer til problemer og trekk forespørsler

Du kan få opp en liste over forslag til problemstillinger og trekk forespørsler i depotet ved å skrive #., Skriv spørsmålet eller trekke forespørsel nummer eller tittel for å filtrere listen, og deretter trykker du en tab eller enter for å fullføre uthevet resultat.

For mer informasjon, se «Autolinked referanser og Nettadresser.»

Referering av eksterne ressurser

Hvis tilpassede autolink referanser er konfigurert for et depot, deretter referanser til eksterne ressurser, som en JIRA problemet-eller Zendesk billett, konvertere til kortere linker. Å vite hvilke autolinks er tilgjengelige i depotet ditt, kontakt noen med admin-rettigheter til depotet., For mer informasjon, se «Konfigurere autolinks å referere til eksterne ressurser.»

Innhold vedlegg

Noen GitHub Apps gi informasjon i GitHub for Nettadresser som link til deres registrerte domener. GitHub gjengir informasjon fra appen under URL-adressen i kroppen eller kommentar på et problem eller trekke forespørsel.

for Å se innholdet vedlegg, du må ha en GitHub-App som bruker Innholdet Vedlegg API installert på depotet., For mer informasjon, se «Installere en app på din personlige konto» og «Installere en app i din organisasjon.»

Innhold vedlegg vil ikke bli vist Nettadresser som er en del av en markdown link.

For mer informasjon om å bygge en GitHub-App som bruker innhold vedlegg, se «Bruke Innhold Vedlegg.»

ved Hjelp av emoji

Du kan legge til emoji å skrive ved å skrive :EMOJICODE:.

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

å Skrive : vil du få opp en liste over foreslåtte emoji-tegn., Listen filtreres mens du skriver, slik at når du finner emoji du leter etter, trykk Tab eller Enter for å fullføre uthevet resultat.

For en fullstendig liste over tilgjengelige emoji-tegn og koder, sjekk ut Emoji-Cheat-Ark.

Avsnitt

Du kan opprette et nytt avsnitt ved å legge inn en blank linje mellom linjer av tekst.

Ignorerer Markdown formatering

Du kan fortelle GitHub å overse (eller rømme) Markdown formateringen ved å bruke \ før Markdown karakter.,

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

For mer informasjon, se Daring Fireball er «Markdown Syntaks.»

Mer å lese

• GitHub Flavored Markdown Spec
• «Om skriving og formatering på GitHub»
• Arbeide med avansert formatering»
• «Mastering Markdown»