Grundlæggende skrivning og formatering syntaks

Overskrifter

for At oprette en overskrift, skal du tilføje en til seks # symboler før din overskrift. Antallet af # du bruger bestemmer størrelsen på overskriften.

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

Styling tekst

Du kan angive vægt med fed, kursiv, eller gennemstreget tekst.

citerer tekst

Du kan citere tekst med en >.,

In the words of Abraham Lincoln:> Pardon my French

citerer kode

Du kan kalde kode eller en kommando i en sætning med enkelte backticks. Teksten i backticks vil ikke blive formateret.,

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

for at formatere kode eller tekst i sin egen særskilte blok skal du bruge tredobbelte backticks.

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

For mere information, se “Oprettelse og fremhæve kode blokke.”

Links

Du kan oprette en inline link ved indpakning link tekst i parentes , og derefter indpakning URL i parentes ( ). Du kan også bruge tastaturgenvejen command + k til at oprette et link.,

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

– Afsnittet links

Du kan linke direkte til et afsnit i en afsmeltet fil ved at holde musen over afsnitsoverskriften til at udsætte link:

Relative links

Du kan angive relative links og billede stier i din renderede filer for at hjælpe læsere med at navigere til andre filer i arkivet.,

et relativt link er et link, der er i forhold til den aktuelle fil. For eksempel, hvis du har en README-fil i roden af dit depot, og at du har en anden fil i docs/BIDRAGE.md, den relative link til at BIDRAGE.md i din README-fil kan se ud som dette:

(docs/CONTRIBUTING.md)

GitHub vil automatisk omdanne din relative link eller billede sti, der er baseret på, hvad gren, du er i øjeblikket på, således at linket eller sti, der altid virker. Du kan bruge alle relative linkoperander, såsom ./ og ../.,Relative links er lettere for brugere, der kloner dit arkiv. Absolutte links fungerer muligvis ikke i kloner i dit arkiv-vi anbefaler at bruge relative links til at henvise til andre filer i dit arkiv.

Lister

Du kan foretage en uordnet liste ved at foranstille en eller flere linjer tekst med - eller *.

- George Washington- John Adams- Thomas Jefferson

for at bestille din liste skal du gå forud for hver linje med et tal.,

1. James Madison2. James Monroe3. John Quincy Adams

Indlejrede Lister

Du kan oprette en indlejret liste af indrykkede en eller flere liste-elementer under en anden konto.hvis du vil oprette en indlejret liste ved hjælp af Gebeditoren på GitHub eller en teksteditor, der bruger en monospaced skrifttype, som Atom, kan du justere din liste visuelt. Skriv mellemrumstegn foran dit indlejrede listeelement, indtil listemarkeringstegnet (- eller *) ligger direkte under det første tegn i teksten i elementet over det.,

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

for At oprette en indlejret liste i kommentar redaktør på GitHub, som ikke bruger en monospaced font, du kan se på listen element, der ligger umiddelbart over den indlejrede liste og tæller antallet af tegn, der vises, før indholdet af elementet. Skriv derefter det antal rumtegn foran det indlejrede listeelement.,

I dette eksempel, kan du tilføje et indlejret element på listen under punkt på listen 100. First list item ved indrykning den indlejrede liste punkt et minimum af fem rum, da der er fem tegn (), før First list item.

100. First list item - First nested list item

Du kan oprette flere niveauer af indlejrede lister ved hjælp af den samme metode., For eksempel, fordi det første indlejrede listeelement har syv mellemrum (␣␣␣␣␣-␣) før det indlejrede Listeindhold First nested list item, skal du indrykke det andet indlejrede listeelement med syv mellemrum.

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

For flere eksempler, se GitHub Krydret Markdown Spec.

opgavelister

for at oprette en opgaveliste, forord listeelementer med et almindeligt mellemrum tegn efterfulgt af. For at markere en opgave som komplet skal du bruge .,

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

Hvis en opgave liste post beskrivelse begynder med en parentes, du bliver nødt til at slippe det med \:

- \(Optional) Open a followup issue

For mere information, se “Om opgave-lister.”

omtale af personer og hold

Du kan nævne en person eller et team på GitHub ved at skrive@ plus deres Brugernavn eller holdnavn. Dette vil udløse en meddelelse og bringe deres opmærksomhed på samtalen., Folk vil også modtage en meddelelse, hvis du redigerer en kommentar for at nævne deres Brugernavn eller teamnavn. Du kan finde flere oplysninger om meddelelser i “om meddelelser.”

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

Når du nævner en forælder team, der er medlemmer af sin barn-hold også modtage meddelelser, forenkle kommunikation med mange forskellige grupper af mennesker. For mere information, se “om teams.”

indtastning af et@ symbol viser en liste over personer eller hold på et projekt., Listen filtrerer, mens du skriver, så når du først har fundet navnet på den person eller det team, du leder efter, kan du bruge piletasterne til at vælge det og trykke på enten tab eller enter for at fuldføre navnet. For hold skal du indtaste @ organi .ation / team-navnet, og alle medlemmer af det hold vil blive abonneret på samtalen.

autofuldførelsesresultaterne er begrænset til repository-samarbejdspartnere og andre deltagere på tråden.

henvisninger til problemer og trækanmodninger

Du kan få vist en liste over foreslåede problemer og trækanmodninger i arkivet ved at skrive#., Skriv problemet eller træk anmodningsnummer eller titel for at filtrere listen, og tryk derefter på enten fane eller enter for at afslutte det fremhævede resultat.

For mere information, se “autolinkede referencer og Urebadresser.”

henvisninger til eksterne ressourcer

Hvis brugerdefinerede autolink-referencer er konfigureret til et arkiv, konverteres henvisninger til eksterne ressourcer, som et JIRA-problem eller ticketendesk-billet, til forkortede links. For at vide, hvilke autolinks der er tilgængelige i dit arkiv, skal du kontakte nogen med administratorrettigheder til arkivet., For mere information, se ” Konfiguration af autolinks til reference eksterne ressourcer.”

indhold vedhæftede filer

nogle GitHub Apps giver oplysninger i GitHub for Urebadresser, der linker til deres registrerede domæner. GitHub gengiver oplysningerne fra appen under URL ‘ en i kroppen eller kommentaren til et problem eller en pull-anmodning.

for at se indhold vedhæftede filer, skal du have en GitHub App, der bruger Content Attachments API installeret på lageret., Du kan finde flere oplysninger under “installation af en app på din personlige konto” og “installation af en app i din organisation.”

indhold vedhæftede filer vil ikke blive vist for Urebadresser, der er en del af en markdo .n link.

For mere information om opbygning af en GitHub App, der bruger indhold, vedhæftede filer, se “Brug af Indhold, Vedhæftede filer.”

brug af emoji

Du kan tilføje emoji til din skrivning ved at skrive :EMOJICODE:.

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

at Skrive : vil bringe en liste over foreslåede emoji., Listen filtreres, mens du skriver, så når du har fundet den emoji, du leder efter, skal du trykke på Tab eller Enter for at afslutte det fremhævede resultat.for en komplet liste over tilgængelige emoji og koder, tjek Emoji-Cheat-Sheet.

afsnit

Du kan oprette et nyt afsnit ved at efterlade en tom linje mellem tekstlinjer.

Ignorerer Markdown formatering

Du kan fortælle GitHub at ignorere (eller flugt) Markdown formatering ved hjælp af \ før Markdown karakter.,

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

For mere information, se Daring Fireball ‘ s “Markdown Syntax.”

Yderligere læsning

• GitHub Krydret Markdown Spec
• “Om at skrive og formatering på GitHub”
• “, der Arbejder med avanceret formatering”
• “Mastering Markdown”