Markdown Toolbox Logo Markdown Toolbox
Dom
Bloga

Arkusz ściągawki - Markdown w stylu GitHub

2023-12-12

Markdown o smaku GitHub (GFM) rozszerza standardową składnię Markdown, aby dodać niektóre dodatkowe funkcje specyficzne dla GitHub. Ta ściągawka obejmuje kluczowe aspekty GFM, ułatwiając tworzenie plików README, zagadnień i innej dokumentacji na GitHubie.

Rozszerzona składnia

Listy zadań

  • Twórz listy zadań używając - [ ] dla nieukończonego zadania i - [x] dla ukończonego zadania.

    -   [x] Ukończone zadanie
-   [ ] Nieukończone zadanie

Przekreślenie

  • Użyj podwójnych tyld ~~, aby przekreślić tekst.

    ~~Przekreślenie~~

Tabele

  • Twórz tabele używając myślników - i pionowych kresek |.

    | Nagłówek 1 | Nagłówek 2 |
| -------- | -------- |
| Wiersz 1 | Dane 1 |
| Wiersz 2 | Dane 2 |

Bloki kodu z otaczającymi je znacznikami

  • Użyj potrójnych backticków (```) i określ język do podświetlania składni.

    ```javascript console.log("Witaj, świecie!"); ```

Wspominanie użytkowników i zespołów

  • Użyj @nazwa_użytkownika, aby wspomnieć użytkownika lub zespół.

Odniesienia do zagadnień i pull requestów

  • Odniesienia do zagadnień i pull requestów używając #.

Standardowa składnia Markdown

Nagłówki

  • Użyj # dla nagłówków. Więcej # oznacza mniejsze nagłówki.

Formatowanie tekstu

  • Pogrubienie: **pogrubienie**
  • Kursywa: *kursywa*
  • Pogrubione i kursywą: ***pogrubione & kursywą***

Listy

  • Lista nieuporządkowana: Zaczynaj od -, + lub *.
  • Lista uporządkowana: Zaczynaj od numerów, po których następuje ..

Linki i obrazy

  • Link: [Tytuł](URL)
  • Obraz: ![Tekst alternatywny](URL)

Cytaty blokowe

  • Użyj > dla cytatów blokowych.

Markdown GitHub umożliwia bardziej interaktywną i dynamiczną dokumentację, szczególnie przydatną w kontekście projektów współpracy.