Podkreślenie w Markdown: co działa na GitHub i w innych rendererach

Markdown nie ma natywnej składni podkreślania tekstu. W CommonMark i GitHub Flavored Markdown _tekst_ oznacza kursywę, a __tekst__ pogrubienie. Podkreślenie zwykle wymaga obsługi HTML lub rozszerzenia konkretnej aplikacji.

Na GitHub udokumentowano następującą formę:

<ins>Zmieniony termin</ins> przypada w piątek.

GitHub wymienia <ins>...</ins> dla podkreślonego tekstu w dokumentacji podstawowego formatowania. To opcja HTML obsługiwana przez platformę, a nie nowy ogranicznik Markdown działający wszędzie.

Porównanie podkreślenia, pogrubienia i kursywy

Źródło	Znaczenie	Gdzie oczekiwać obsługi
_ważne_	Wyróżnienie, zwykle kursywa	CommonMark i GFM
__ważne__	Silne wyróżnienie, zwykle pogrubienie	CommonMark i GFM
**ważne**	Silne wyróżnienie, zwykle pogrubienie	CommonMark i GFM
<ins>dodany tekst</ins>	Wstawiony tekst, zwykle podkreślony	Renderery z HTML; udokumentowane przez GitHub
<u>tekst z adnotacją</u>	Adnotacja HTML, zwykle podkreślona	Renderery dopuszczające ten element HTML

Wybierz pogrubienie lub kursywę, gdy celem jest wyróżnienie. Na przykład **Termin: piątek** pozostaje użyteczne w README, notatce i eksporcie Markdown bez zależności od surowego HTML.

Czym różnią się ins i u?

Oba znaczniki mogą wyglądać podobnie, ale mają inne znaczenie.

<ins> reprezentuje tekst wstawiony do dokumentu. Pasuje do poprawki, na przykład nowo dodanego wymagania. Przeglądarka zwykle go podkreśla, lecz arkusz stylów może zmienić wygląd. Zobacz opis wstawionego tekstu w MDN.

Wydanie obsługuje <ins>import CSV i TSV</ins>.

<u> oznacza adnotację, która nie jest zwykłym wyróżnieniem, na przykład wskazanie błędu ortograficznego. Współczesny HTML nie definiuje go jako uniwersalnego znacznika „nadaj ważność”. Zobacz opis elementu u w MDN.

Sprawdź pisownię słowa <u>ktury</u>.

Jeśli kontrolujesz witrynę i potrzebujesz wyłącznie wizualnego podkreślenia, zastosuj text-decoration: underline przez CSS. Hostowana platforma Markdown może usuwać atrybuty stylu lub zabraniać własnych stylów, więc to rozwiązanie również nie jest przenośne.

Dlaczego podkreślenie działa w jednym edytorze, a znika w innym?

To trzy osobne decyzje: parser Markdown rozpoznaje HTML, aplikacja wybiera dozwolone znaczniki, a arkusz stylów miejsca docelowego określa wygląd dozwolonych elementów. Obsługa GFM nie gwarantuje, że produkt pozwala na wszystkie znaczniki HTML.

Edytor MD File Viewer obecnie usuwa surowe znaczniki HTML z danych użytkownika. Wklejenie <ins>dodany tekst</ins> lub <u>tekst z adnotacją</u> pozostawia słowa bez tych znaczników, więc podgląd ich nie podkreśli. Korzystaj z podglądu dla obsługiwanego formatowania Markdown, a formatowanie oparte na HTML sprawdzaj w miejscu publikacji.

Jeśli przenosisz dokument HTML do Markdown, konwerter HTML na Markdown pomaga odzyskać tekst, nagłówki, odnośniki i listy. Podkreślenie i własny CSS mogą zniknąć, ponieważ zwykły Markdown nie ma odpowiedniej składni. Sprawdź wynik przed zastąpieniem oryginalnego dokumentu.

Przykłady README na GitHub

Dla krótkiego dodatku w informacji o zmianach GitHub dokumentuje taką opcję HTML:

Ta wersja dodaje <ins>opcjonalny krok importu</ins>.

Dla terminu lub wymagania użyj wyróżnienia Markdown:

**Wymagane:** Dodaj wiersz nagłówka do pliku CSV.

Aby wskazać miejsce docelowe, użyj odnośnika:

[Przeczytaj instrukcję importu](https://example.com/import)

Podkreślony tekst może wyglądać jak klikalny odnośnik. Nie nadawaj zwykłym etykietom wyglądu interaktywnego, zwłaszcza gdy ten sam akapit zawiera prawdziwe odnośniki. Przewodnik po odnośnikach Markdown omawia opisowy tekst odnośników i odnośniki referencyjne.

Częste błędy z podkreśleniem

Podwójne podkreślenia pogrubiają tekst. Zmiana **słowo** na __słowo__ zmienia ogranicznik, a nie znaczenie. Oba zapisy reprezentują silne wyróżnienie.

Odwrotne apostrofy pokazują znacznik jako kod. Zapis `<ins>tekst</ins>` przydaje się w poradniku, ale celowo pokazuje znaczniki zamiast je renderować.

Skróty klawiaturowe należą do aplikacji. Edytor tekstu sformatowanego może oferować polecenie podkreślenia i zapisywać HTML lub własny format dokumentu. Nie czyni to podkreślenia częścią przenośnego Markdown.

Podkreślony nagłówek to inne pojęcie. W tym źródle łączniki tworzą nagłówek drugiego poziomu:

Informacje o wydaniu
-------------

Nie podkreślają frazy wewnątrz akapitu. Dla separatora między sekcjami użyj poziomej linii Markdown z pustymi wierszami wokół niej.

Często zadawane pytania

Jak podkreślić tekst Markdown na GitHub?

Użyj <ins>tekst</ins>, które GitHub dokumentuje dla podkreślenia. Dla wyróżnienia działającego także bez obsługi HTML użyj **tekst** lub *tekst*.

Czy istnieje alternatywa podkreślenia używająca tylko Markdown?

Nie ma standardowego ogranicznika podkreślenia. Niektóre aplikacje dodają własną składnię, ale trzeba sprawdzić ich dokumentację i format używany podczas eksportu.

Czy podkreślenie przetrwa konwersję Markdown na PDF lub Word?

Tylko jeśli konwerter zachowuje odpowiedni HTML lub rozszerzenie i obsługuje jego style. Nie zakładaj, że podkreślenie widoczne w podglądzie jednej aplikacji przetrwa eksport w innej. Sprawdź wynikowy plik lub użyj standardowego pogrubienia, jeśli ważna jest przenośność.

Ściągawka Markdown to zwięzłe zestawienie formatowania, które ma dedykowaną składnię Markdown.