Markdown cheat sheet

Markdown cheat sheet met live preview (GitHub + CommonMark) | We.Inc

Elk Markdown-element met een voorbeeld dat u kunt bewerken en direct gerenderd ziet: regeleinden, links, tabellen, checkboxes, voetnoten, codeblokken en GitHub-alerts, plus een README-sjabloon.

Markdown cheat sheet

Markdown maakt gewone tekst op met een paar symbolen: # voor koppen, **twee sterretjes** voor vet, [tekst](adres) voor links, - voor opsommingen en drie backticks voor codeblokken. Elk voorbeeld hieronder kunt u bewerken, en de preview ernaast wordt bijgewerkt terwijl u typt, zodat u een syntax kunt testen voordat u hem gebruikt.

De vijf die u het meest gebruikt

  • U wilt
  • Typ
  • Kop
  • Vet
  • **important**
  • Link
  • [label](https://example.com)
  • Opsomming
  • - item
  • Nieuwe regel
  • twee spaties aan het einde van een regel

Achttien live voorbeelden die alles behandelen van koppen tot voetnoten en GitHub-alerts, een tabel met de verschillen tussen GitHub en standaard CommonMark, een README-sjabloon en een volledige editor onderaan de pagina.

  • Zoek het element dat u nodig hebt. Het label onder elk voorbeeld zegt of het overal werkt, in GitHub en de meeste apps, of alleen op GitHub.
  • Bewerk de Markdown in het linkervak. De preview rechts rendert hem terwijl u typt.
  • Gebruik Herstellen om het oorspronkelijke voorbeeld terug te zetten en Kopiëren om de Markdown mee te nemen.
  • Gebruik voor langere teksten de volledige editor onderaan, of laad het README-sjabloon erin.
  • Laat een lege regel vóór en na lijsten, tabellen, codeblokken en koppen. Veel renderers hebben dat nodig, en het kan nooit kwaad.
  • Schrijf alt-tekst voor elke afbeelding. Dat is wat gebruikers van een schermlezer horen en wat verschijnt als de afbeelding niet laadt.
  • Gebruik referentielinks in lange documenten. De tekst blijft leesbaar en elk adres wordt maar één keer geschreven.
  • Als iets als platte tekst verschijnt, controleer dan of er een spatie ontbreekt: #Heading en -item worden niet herkend; # Heading en - item wel.

Veelgestelde vragen

Hoe maak ik een regeleinde in Markdown?

Eindig de regel met twee spaties of een backslash en druk dan op Enter. Een gewone Enter wordt als spatie behandeld en de regels worden samengevoegd. Laat voor een nieuwe alinea in plaats van een regeleinde één lege regel.

Hoe voeg ik een checkbox toe in Markdown?

Begin een lijstitem met - [ ] voor een leeg vakje of - [x] voor een aangevinkt vakje. Takenlijsten horen bij GitHub Flavored Markdown, dus ze werken op GitHub, GitLab en de meeste notitie-apps, maar niet in strikte CommonMark.

Hoe maak ik een tabel?

Schrijf de kopregel met pipes tussen de kolommen, dan een regel met streepjes, dan één regel per rij. De kolommen hoeven in de bron niet uitgelijnd te zijn. Voeg dubbele punten toe aan de regel met streepjes om een kolom links, rechts of gecentreerd uit te lijnen.

Wat is het verschil tussen Markdown, CommonMark en GFM?

Markdown is de oorspronkelijke syntax uit 2004, die veel gevallen ongedefinieerd liet. CommonMark is een precieze specificatie van die kernsyntax. GitHub Flavored Markdown is CommonMark plus tabellen, takenlijsten, doorhalen, automatische links en voetnoten, en is wat de meeste ontwikkelaarstools volgen.

Kan ik HTML gebruiken in Markdown?

De meeste renderers staan het toe, dus details- en summary-tags of een gecentreerde afbeelding zijn gebruikelijk in README's. GitHub verwijdert om veiligheidsredenen scripts, styles en sommige attributen. De previews op deze pagina renderen geen ruwe HTML en tonen die dus als tekst.

Waarom Markdown er in verschillende apps anders uitziet

  • De oorspronkelijke beschrijving van Markdown liet veel randgevallen open, zoals hoe ver een geneste lijst moet inspringen of of een regeleinde twee spaties nodig heeft. Elke app maakte zijn eigen keuzes. CommonMark legde die regels vast in een specificatie, en de meeste moderne tools volgen die nu en voegen er hun eigen extra's aan toe.
  • Daarom is het label over ondersteuning belangrijk. Koppen, nadruk, links, lijsten, citaten en code werken overal. Tabellen, checkboxes, doorhalen en voetnoten komen uit de extensies van GitHub en werken op de meeste, maar niet alle, plaatsen. Alerts zijn van GitHub zelf.

Een goede README schrijven

  • Een README is de voorpagina van een project. Begin met één zin over wat het doet en voor wie het is, laat dan in een kopieerbaar codeblok zien hoe u het installeert en uitvoert, en daarna het kleinste nuttige voorbeeld. Zet lang naslagmateriaal in aparte bestanden en link ernaar.
  • Het sjabloon hieronder volgt die volgorde. Laad het in de editor, vervang de plaatshoudertekst en kopieer het resultaat naar README.md.

Koppen

Eén tot zes #-tekens, dan een spatie. Gebruik één #-kop per document.

Vet en cursief

Underscores (__bold__, _italic_) werken ook, maar niet midden in een woord.

Doorhalen

Twee tildes aan elke kant. Onderdeel van GitHub Flavored Markdown, niet van de kern van CommonMark.

Regeleinden

Een enkele Enter breekt de regel niet af. Eindig met twee spaties of een backslash, of laat een lege regel voor een nieuwe alinea.

Links

Tekst tussen vierkante haken, adres tussen ronde haken. Punthaken maken een kaal adres klikbaar.

Referentielinks

Houdt lange adressen uit de tekst. De definities kunnen overal staan en worden niet getoond.

Afbeeldingen

Zoals een link met ! ervoor. De tekst tussen haken is de alt-tekst die schermlezers voorlezen.

Lijsten

Gebruik -, * of + voor opsommingstekens en 1. voor nummers. Spring twee tot vier spaties in om te nesten.

Checkboxes (takenlijsten)

Een spatie tussen de haken is niet aangevinkt; een x is aangevinkt. Op GitHub kunt u ze in issues aanvinken.

Citaten

Begin elke regel met >. Een regel met alleen > houdt de alinea's in één citaat.

Inline code

Backticks houden tekst precies zoals getypt. Om een backtick te tonen, omring hem met twee: `` a`b ``.

Codeblokken

Drie backticks ervoor en erna. Het woord na de openingsfence noemt de taal voor syntax highlighting.

Tabellen

Pipes scheiden kolommen; de regel met streepjes is verplicht. Dubbele punten bepalen de uitlijning: links, rechts of gecentreerd.

Horizontale lijn

Drie of meer streepjes, sterretjes of underscores op een eigen regel. Laat lege regels rond streepjes, zodat ze niet als onderstreping van een kop worden gelezen.

Voetnoten

De noot wordt onderaan het document verzameld met een link terug.

Tekens escapen

Een backslash vóór * _ # [ ] ` en vergelijkbare tekens toont ze als platte tekst.

Automatische links

GitHub maakt van kale adressen links. Strikte CommonMark heeft punthaken nodig.

Alerts (callouts)

GitHub toont deze als gekleurde vakken; andere apps tonen een gewoon citaat, zoals de preview hier doet.

Markdown-syntax en waar hij werkt

  • Element
  • Markdown
  • Werkt in

Waar GitHub Flavored Markdown afwijkt van CommonMark

  • Functie
  • CommonMark
  • GitHub (GFM)
  • Tabellen
  • Niet ondersteund
  • Ondersteund
  • Checkboxes in takenlijsten
  • Niet ondersteund
  • Ondersteund, aanklikbaar in issues en pull requests
  • Doorhalen
  • Niet ondersteund
  • ~~text~~
  • Kale URL's worden links
  • Alleen binnen <punthaken>
  • Ja, voor http-, https- en www-adressen
  • Voetnoten
  • Niet ondersteund
  • Ondersteund
  • Alerts zoals > [!NOTE]
  • Gewoon citaat
  • Vormgegeven callout-vak
  • Ruwe HTML
  • Toegestaan
  • Toegestaan, maar scripts, styles en sommige tags worden verwijderd
  • Vermeldingen en issuelinks
  • Platte tekst
  • @user en #123 worden links

Overal

GitHub en de meeste apps

Alleen GitHub

Markdown (bewerk mij)

Preview

Kopiëren

Herstellen

Syntax in één oogopslag

Elk element, live

GitHub vs CommonMark

README-sjabloon

Sjabloon kopiëren

Openen in de editor

Volledige editor

Markdown

Markdown kopiëren

{n} woorden. Er wordt niets opgeslagen of verstuurd.

Bouw je site gratis · Gratis bouwen, geen kaart nodig

Gerelateerd: Gidsen

Product

Voor wie

Functies

Bronnen

Bedrijf

Sitemap