Ściągawka do Markdown

Krok 1 / 3 33%

Wybierz temat Markdown

Najpierw wybierz jedną grupę przykładów, a potem otwórz pełną ściągawkę.

Najważniejsza składnia Markdown, uporządkowana według kategorii i pokazana jako źródło gotowe do skopiowania oraz wynik prawdziwego parsera. Obejmuje podstawy CommonMark (nagłówki, listy, wyróżnienia, linki, obrazy i ogrodzone bloki kodu) oraz rozszerzenia GitHub Flavored Markdown (tabele, listy zadań, przekreślenie i automatyczne linkowanie zwykłych adresów URL). Warto mieć ją pod ręką podczas pracy z GitHubem, GitLabem, Obsidianem i generatorami stron statycznych.

Jak korzystać ze ściągawki

  1. 1

    Przeglądaj według kategorii

    Przejdź do nagłówków, list, kodu, odnośników, tabel lub rozszerzeń GFM.

  2. 2

    Porównaj źródło z wynikiem

    Każdy przykład pokazuje surowy Markdown obok wyniku prawdziwego parsera GFM.

  3. 3

    Skopiuj fragment

    Dotknij „Kopiuj”, aby pobrać źródło dowolnego przykładu.

  4. 4

    Sprawdź etykietę składni

    Każdy przykład jest oznaczony jako CommonMark albo GitHub Flavored Markdown (GFM).

Nagłówki

# Nagłówek H1
## Sekcja H2
### Podsekcja H3

Używaj stylu ATX (#) zamiast Setext (=== pod tekstem). Wszystkie parsery obsługują oba, ale ATX jest łatwiejszy do odczytania w porównaniu zmian (diff).

Wyróżnienie

*kursywa* lub _kursywa_, **pogrubienie** lub __pogrubienie__, ***pogrubiona kursywa***. GFM dodaje ~~przekreślenie~~.

Listy

Listy nieuporządkowane używają -, * lub + (wybierz jeden i trzymaj się go):

- Pierwszy
- Drugi
  - Zagnieżdżony (dwie spacje)

Listy uporządkowane numerują się automatycznie:

1. Element
1. Element
1. Element

Kod

W tekście: `code`. Bloki w ogrodzeniu z opcjonalnym tagiem języka:

```python
def hello(name):
    return f"Cześć, {name}"
```

Jeśli wolisz starszą składnię, wcięcie bloku kodu zrób czterema spacjami.

Odnośniki i obrazy

[Tekst odnośnika](https://example.com)
[Odnośnik z tytułem](https://example.com "Podpowiedź")
![Tekst alternatywny](/path/to/image.png)

Styl referencyjny utrzymuje długie adresy URL poza akapitem:

Zobacz [dokumentację][1].

[1]: https://example.com/docs

Tabele (GFM)

| Col A | Col B |
|-------|------:|
| a     |     1 |
| b     |    22 |

Wyrównanie ustawia się dwukropkami w wierszu rozdzielającym: :--- do lewej, :---: do środka, ---: do prawej.

Listy zadań (GFM)

- [x] Gotowe
- [ ] Do zrobienia

Najczęstsze pułapki

  • Dwie spacje na końcu wiersza wstawiają złamanie wiersza w akapicie. Pojedyncza spacja jedynie łączy wiersze.
  • Wymagany jest pusty wiersz przed większością elementów blokowych (nagłówki, listy, bloki kodu).
  • Nie stosuj wcięć znaczników list tabulatorami, jeśli twój renderer oczekuje spacji; zrób wcięcie dwiema lub czterema spacjami.
  • Ucieczka odwrotnym ukośnikiem dla dosłownych znaków interpunkcyjnych: \*nie kursywa\*.
  • Inteligentne cudzysłowy różnią się w zależności od renderera. GitHub zostawia je bez zmian; Pandoc je konwertuje.

Najczęściej zadawane pytania

CommonMark definiuje przenośny rdzeń, w tym nagłówki, listy, linki i ogrodzone bloki kodu z opcjonalnym opisem. GFM dodaje tabele, listy zadań, przekreślenie oraz automatyczne linki dla zwykłych adresów URL. Inne edytory mogą obsługiwać tylko część składni lub dodawać własne rozszerzenia.

Markdown traktuje pojedynczy znak nowego wiersza jak spację. Aby uzyskać <br>, zakończ wiersz dwiema spacjami lub użyj \ na końcu wiersza w GFM.

Tak, w większości parserów znaczniki HTML na poziomie bloku są przepuszczane. Niektóre renderery je oczyszczają (GitHub usuwa skrypty inline i atrybuty zdarzeń).

CommonMark nie ma wbudowanej składni spisu treści. GitHub tworzy kotwice nagłówków i pokazuje plan plików zawierających kilka nagłówków. Inne platformy mają własne zasady: MkDocs może używać [TOC] po włączeniu odpowiedniego rozszerzenia, a Docusaurus buduje spis treści strony z nagłówków.

Zasady CommonMark i GFM tak. Obsidian dodaje jednak linki wiki ([[Nazwa strony]]), objaśnienia (callout) i osadzone bloki dostępne wyłącznie w Obsidian – tych elementów nie ma w tej ściągawce.

Powiązane narzędzia