Basic writing and formatting syntaxis

heading

om een kop te maken, voeg één tot zes # symbolen toe voor uw koptekst. Het aantal # dat u gebruikt, bepaalt de grootte van de kop.

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

Styling text

u kunt de nadruk aangeven met vetgedrukte, cursieve of doorgestreepte tekst.

tekst citeren

u kunt tekst citeren met een >.,

In the words of Abraham Lincoln:> Pardon my French

aanhalende code

u kunt code of een commando binnen een zin oproepen met enkele backticks. De tekst in de backticks zal niet worden opgemaakt.,

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

om code of tekst in zijn eigen aparte blok te formatteren, gebruik drie backticks.

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

voor meer informatie, zie ” codeblokken maken en markeren.”

koppelingen

U kunt een inline koppeling maken door de tekst van de koppeling tussen haakjes te wikkelen , en vervolgens de URL tussen haakjes te wikkelen ( ). U kunt ook de sneltoets command + k gebruiken om een link te maken.,

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

Sectiekoppelingen

U kunt rechtstreeks linken naar een sectie in een gerenderd bestand door met de muis over de sectiekop te gaan om de link te tonen:

relatieve koppelingen

u kunt relatieve koppelingen en afbeeldingspaden definiëren in uw gerenderde bestanden om lezers te helpen navigeren naar andere bestanden in uw repository.,

een relatieve verwijzing is een verwijzing die relatief is aan het huidige bestand. Bijvoorbeeld, als je een README bestand in de root van je repository hebt, en je hebt een ander bestand in docs / CONTRIBUTING. md, de relatieve link naar CONTRIBUTING.md in je README zou het er zo uit kunnen zien:

(docs/CONTRIBUTING.md)

GitHub zal automatisch je relatieve link of image pad transformeren op basis van welke branch je ook gebruikt, zodat de link of het pad altijd werkt. U kunt alle relatieve link operanden gebruiken, zoals ./ en ../.,

relatieve links zijn gemakkelijker voor gebruikers die uw repository klonen. Absolute links werken mogelijk niet in klonen van je repository – we raden aan relatieve links te gebruiken om te verwijzen naar andere bestanden in je repository.

lijsten

U kunt een ongeordende lijst maken door vooraf te gaan aan een of meer regels tekst met - of *.

- George Washington- John Adams- Thomas Jefferson

om uw lijst te ordenen, wordt elke regel voorafgegaan door een getal.,

1. James Madison2. James Monroe3. John Quincy Adams

geneste lijsten

U kunt een geneste lijst maken door een of meer lijstitems onder een ander item te inspringen.

om een geneste lijst te maken met behulp van de WebEditor op GitHub of een teksteditor die een monospaced lettertype gebruikt, zoals Atom, kunt u uw lijst visueel uitlijnen. Typ spatietekens voor het geneste lijstitem, totdat het lijstmarkerteken (- of *) direct onder het eerste teken van de tekst in het item erboven ligt.,

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

om een geneste lijst aan te maken in de commentaarbewerker op GitHub, die geen monospaced lettertype gebruikt, kunt u het lijstitem direct boven de geneste lijst bekijken en het aantal tekens tellen dat verschijnen voor de inhoud van het item. Typ vervolgens dat aantal spatietekens voor het geneste lijstitem.,

in dit voorbeeld kunt u een genest lijstitem toevoegen onder het lijstitem 100. First list item door het geneste lijstitem minimaal vijf spaties in te drukken, omdat er vijf tekens zijn () voor First list item.

100. First list item - First nested list item

u kunt meerdere niveaus van geneste lijsten maken met dezelfde methode., Bijvoorbeeld, omdat het eerste geneste lijstitem zeven spaties heeft (␣␣␣␣␣-␣) voor de geneste Lijstinhoud First nested list item, moet u het tweede geneste lijstitem inspringen met zeven spaties.

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

voor meer voorbeelden, zie de Github Flavored Markdown Spec.

takenlijsten

om een takenlijst te maken, worden items met een normaal spatieteken gevolgd door . Gebruik om een taak als voltooid te markeren.,

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

als een takenlijstitembeschrijving begint met een haakje, moet u deze ontsnappen met \:

- \(Optional) Open a followup issue

zie “over takenlijsten” voor meer informatie.”

het vermelden van personen en teams

u kunt een persoon of team op GitHub vermelden door @ plus hun gebruikersnaam of teamnaam te typen. Dit zal leiden tot een melding en brengen hun aandacht voor het gesprek., Mensen zullen ook een melding ontvangen als u een Opmerking bewerkt om hun gebruikersnaam of teamnaam te vermelden. Zie ‘over meldingen’ voor meer informatie over meldingen.”

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

wanneer u een ouderteam vermeldt, ontvangen leden van de Kindteams ook meldingen, waardoor de communicatie met meerdere groepen mensen wordt vereenvoudigd. Zie “over teams” voor meer informatie.”

het intikken van een @ symbool zal een lijst van mensen of teams op een project tonen., De lijst filtert terwijl u typt, dus zodra u de naam van de persoon of het team dat u zoekt, kunt u de pijltjestoetsen gebruiken om het te selecteren en druk op tab of enter om de naam te voltooien. Voor teams, voer de @ organisatie / team-naam en alle leden van dat team zullen worden geabonneerd op het gesprek.

de autocomplete resultaten zijn beperkt tot repository-medewerkers en alle andere deelnemers aan de thread.

Referencing issues and pull requests

u kunt een lijst met voorgestelde issues en pull requests binnen de repository weergeven door #te typen., Typ het nummer of de titel van het probleem-of pull-verzoek om de lijst te filteren en druk vervolgens op tab of enter om het gemarkeerde resultaat te voltooien.

voor meer informatie, zie “autolinked referenties en URL’ s.”

Referencing external resources

als aangepaste autolink-verwijzingen zijn geconfigureerd voor een repository, dan worden verwijzingen naar externe bronnen, zoals een JIRA-probleem of Zendesk-ticket, omgezet in verkorte links. Om te weten welke autolinks beschikbaar zijn in je repository, neem je contact op met iemand met beheerdersrechten voor de repository., Zie “autolinks configureren om naar externe bronnen te verwijzen voor meer informatie.”

Content attachments

sommige Github Apps bieden informatie in GitHub voor url ‘ s die linken naar hun geregistreerde domeinen. GitHub geeft de door de app verstrekte informatie weer onder de URL in de body of opmerking van een issue of pull request.

om inhoudbijlagen te zien, moet u een Github App hebben die de INHOUDBIJLAGEN API gebruikt die op de repository is geïnstalleerd., Zie ‘een app installeren in uw persoonlijke account’ en ‘een app installeren in uw organisatie’ voor meer informatie.”

inhoudsbijlagen worden niet weergegeven voor url ‘ s die deel uitmaken van een markdown-link.

voor meer informatie over het bouwen van een Github App die content bijlagen gebruikt, zie “content bijlagen gebruiken.”

met behulp van emoji

kunt u emoji toevoegen aan uw schrijven door :EMOJICODE:te typen.

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

typen : zal een lijst met voorgestelde emoji weergeven., De lijst wordt gefilterd terwijl u typt, dus zodra u de emoji vindt die u zoekt, drukt u op Tab of Enter om het gemarkeerde resultaat te voltooien.

voor een volledige lijst van beschikbare emoji en codes, kijk op de emoji-Cheat-Sheet.

alinea ‘ s

U kunt een nieuwe alinea maken door een lege regel tussen regels tekst te laten.

Markdown-opmaak negeren

U kunt GitHub vertellen om Markdown-opmaak te negeren (of te ontsnappen) door \ te gebruiken voor het Markdown-teken.,

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

voor meer informatie, zie Daring Fireball ‘ s ” Markdown syntaxis.”

verder lezen

• Github Flavored Markdown Spec
• “over schrijven en opmaak op GitHub”
• “werken met geavanceerde opmaak”
• “Mastering Markdown”