grundläggande skrivning och formatering syntax

rubriker

för att skapa en rubrik, Lägg till en till sex# symboler före rubrik text. Antalet# du använder bestämmer storleken på rubriken.

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

Stylingtext

Du kan ange betoning med fet, kursiv eller genomstruken text.

citera text

Du kan citera text med en>.,

In the words of Abraham Lincoln:> Pardon my French

citera kod

Du kan ringa ut kod eller ett kommando i en mening med enstaka backticks. Texten i backticks kommer inte att formateras.,

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

för att formatera kod eller text till sitt eget distinkta block, använd tredubbla backticks.

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

För mer information, se ”Skapa och markera kodblock.”

länkar

Du kan skapa en inline-länk genom att förpacka länktext inom parentes och sedan förpacka webbadressen inom parentes ( ). Du kan också använda snabbtangenten command + k för att skapa en länk.,

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

Sektionslänkar

Du kan länka direkt till ett avsnitt i en renderad fil genom att hålla muspekaren över sektionsrubriken för att visa länken:

relativa länkar

Du kan definiera relativa länkar och bildvägar i dina renderade filer för att hjälpa läsarna att navigera till andra filer i ditt arkiv.,

en relativ länk är en länk som är relativ till den aktuella filen. Till exempel, om du har en README-fil i roten till ditt arkiv, och du har en annan fil i docs/CONTRIBUTING.md, den relativa länken till CONTRIBUTING.md i README kan det se ut så här:

(docs/CONTRIBUTING.md)

GitHub omvandlar automatiskt din relativa länk eller bildväg baserat på vilken gren du än är på, så att länken eller sökvägen alltid fungerar. Du kan använda alla relativa länkoperander, till exempel ./ och ../.,

relativa länkar är enklare för användare som klonar ditt förråd. Absoluta länkar kanske inte fungerar i kloner i ditt förråd-vi rekommenderar att du använder relativa länkar för att hänvisa till andra filer i ditt förråd.

listor

Du kan göra en oordnad lista genom att föregå en eller flera textrader med - eller *.

- George Washington- John Adams- Thomas Jefferson

för att beställa din lista, föregår varje rad med ett nummer.,

1. James Madison2. James Monroe3. John Quincy Adams

kapslade listor

Du kan skapa en kapslad lista genom att dra in en eller flera listobjekt under ett annat objekt.

för att skapa en kapslad lista med hjälp av webbredigeraren på GitHub eller en textredigerare som använder ett monospaced-teckensnitt, som Atom, kan du justera din lista visuellt. Skriv mellanslagstecken framför ditt kapslade listobjekt tills listrutan (- eller *) ligger direkt under textens första tecken i objektet ovanför.,

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

för att skapa en kapslad lista i kommentarredigeraren på GitHub, som inte använder ett monospaced-teckensnitt, kan du titta på listobjektet omedelbart ovanför den kapslade listan och räkna antalet tecken som visas före objektets innehåll. Skriv sedan det antalet mellanslagstecken framför det kapslade listobjektet.,

i det här exemplet kan du lägga till ett kapslat listobjekt under listobjektet 100. First list item genom att dra in det kapslade listobjektet minst fem mellanslag, eftersom det finns fem tecken () före First list item.

100. First list item - First nested list item

Du kan skapa flera nivåer av kapslade listor med samma metod., Till exempel, eftersom det första kapslade listobjektet har sju mellanslag (␣␣␣␣␣-␣) innan det kapslade listobjektet First nested list item måste du dra in det andra kapslade listobjektet med sju mellanslag.

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

för fler exempel, se Github Flavored Markdown Spec.

uppgiftslistor

för att skapa en uppgiftslista, förordlistobjekt med ett vanligt mellanslagstecken följt av. För att markera en uppgift som komplett, använd .,

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

om en beskrivning av uppgiftslistan börjar med en parentes måste du fly från den med \:

- \(Optional) Open a followup issue

För mer information, se ”om uppgiftslistor.”

nämna personer och lag

Du kan nämna en person eller ett lag på GitHub genom att skriva @ plus deras användarnamn eller lagnamn. Detta kommer att utlösa en anmälan och uppmärksamma samtalet., Människor kommer också att få ett meddelande om du redigerar en kommentar för att nämna deras användarnamn eller lagnamn. Mer information om aviseringar finns i ” om aviseringar.”

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

När du nämner ett överordnat team får medlemmarna i sina underordnade Team också meddelanden, vilket förenklar kommunikationen med flera grupper av människor. För mer information, se ” om lag.”

När du skriver en @ – symbol visas en lista över personer eller team i ett projekt., Listan filtrerar när du skriver, så när du hittar namnet på den person eller det team du letar efter, kan du använda piltangenterna för att välja den och tryck antingen tab eller enter för att slutföra namnet. För lag, skriv in @organisation / lagnamn och alla medlemmar i det laget kommer att få prenumerera på konversationen.

resultaten för automatisk komplettering är begränsade till förvarskollaboratörer och andra deltagare i tråden.

referera frågor och dra förfrågningar

Du kan ta upp en lista över föreslagna problem och dra förfrågningar i arkivet genom att skriva#., Skriv problemet eller dra begäranummer eller titel för att filtrera listan och tryck sedan på antingen flik eller enter för att slutföra det markerade resultatet.

För mer information, se ”Autolinked referenser och Webbadresser.”

referera till externa resurser

Om anpassade autolinkreferenser är konfigurerade för ett arkiv, omvandlas referenser till externa resurser, som ett JIRA-problem eller Zendesk-biljett, till förkortade länkar. För att veta vilka autolänkar som finns tillgängliga i ditt förråd, kontakta någon med administratörsbehörighet till förvaret., Mer information finns i Konfigurera autolänkar för att referera till externa resurser.”

innehållsbilagor

vissa GitHub-appar tillhandahåller information i GitHub för webbadresser som länkar till sina registrerade domäner. GitHub ger den information som tillhandahålls av appen under webbadressen i kroppen eller kommentar av ett problem eller pull begäran.

för att se innehållsbilagor måste du ha en GitHub-App som använder content Attachments API installerat på arkivet., Mer information finns i Installera en app i ditt personliga konto och installera en app i din organisation.”

innehållsbilagor visas inte för webbadresser som ingår i en markdown-länk.

Mer information om hur du bygger en GitHub-App som använder innehållsbilagor finns i ”Använda Innehållsbilagor.”

använda emoji

Du kan lägga till emoji i ditt skrivande genom att skriva :EMOJICODE:.

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

skriva : kommer att ta upp en lista över föreslagna emoji., Listan kommer att filtrera när du skriver, så när du hittar emoji du letar efter, tryck på Tab eller Enter för att slutföra det markerade resultatet.

för en fullständig lista över tillgängliga emoji och koder, kolla in Emoji-Cheat-Sheet.

stycken

Du kan skapa ett nytt stycke genom att lämna en tom rad mellan textrader.

ignorera Markdown formatering

Du kan be GitHub att ignorera (eller fly) Markdown formatering genom att använda\ innan Markdown karaktär.,

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

För mer information, se Daring fireballs ”Markdown Syntax.”

ytterligare läsning

• Github Flavored Markdown Spec
• ”Om att skriva och formatera på GitHub”
• ”arbeta med avancerad formatering”
• ”Mastering Markdown”