Markdown Toolbox Logo Markdown Toolbox
Thuis
Bloggen

Vereenvoudigde gids - GitHub-stijl Markdown

2023-12-12

GitHub Flavor Markdown (GFM) breidt de standaard Markdown-syntaxis uit om enkele extra functies specifiek voor GitHub op te nemen. Deze cheat sheet behandelt de belangrijkste aspecten van GFM, waardoor het gemakkelijker wordt om README's, problemen en andere documentatie op GitHub te creëren.

Uitgebreide Syntaxis

Taaklijsten

  • Maak taaklijsten met - [ ] voor een onvoltooid taak en - [x] voor een voltooide taak.

    -   [x] Voltooide taak
-   [ ] Onvoltooide taak

Doorhalen

  • Gebruik dubbele tildes ~~ om tekst door te strepen.

    ~~Doorhalen~~

Tabellen

  • Maak tabellen met streepjes - en pipes |.

    | Kop 1  | Kop 2  |
| ------- | ------- |
| Rij 1  | Gegevens 1 |
| Rij 2  | Gegevens 2 |

Omheinde Codeblokken

  • Gebruik driedubbele backticks (```) en specificeer een taal voor syntaxisaccentuering.

    ```javascript console.log("Hallo, wereld!"); ```

Gebruikers en Teams Vermelden

  • Gebruik @gebruikersnaam om een gebruiker of team te vermelden.

Referenties naar Problemen en Pull Requests

  • Verwijs naar problemen en pull requests met #.

Standaard Markdown-syntaxis

Koppen

  • Gebruik # voor koppen. Meer #s betekent kleinere koppen.

Tekstopmaak

  • Vet: **vet**
  • Schuin: *schuin*
  • Vet en Schuin: ***vet & schuin***

Lijsten

  • Ongeordende Lijst: Begin met -, +, of *.
  • Geordende Lijst: Begin met nummers gevolgd door ..

Links en Afbeeldingen

  • Link: [Titel](URL)
  • Afbeelding: ![Alternatieve tekst](URL)

Blockquotes

  • Gebruik > voor blockquotes.

Markdown van GitHub staat meer interactieve en dynamische documentatie toe, vooral nuttig in de context van samenwerkingsprojecten.