Generator linków Markdown

Cztery warianty linków

W tekście, bez tytułu:

[Przeczytaj dokumentację](https://example.com/docs)

W tekście z tytułem (dymek po najechaniu kursorem):

[Przeczytaj dokumentację](https://example.com/docs "Pełna dokumentacja")

Styl referencyjny (adres URL zdefiniowany poniżej):

Otwórz [dokumentację][docs] lub [dziennik zmian][cl].

[docs]: https://example.com/docs
[cl]:   https://example.com/changelog

Autolink (adres URL jest jednocześnie tekstem i celem):

<https://example.com>

Kiedy wybrać który

• W tekście, do sporadycznych linków, gdy adres URL jest krótki, a akapit nadal dobrze się czyta.
• Styl referencyjny, gdy cytujesz ten sam adres URL wielokrotnie lub gdy adres URL to śledzący potwór liczący 200 znaków, który w innym wypadku zaburzyłby płynność akapitu.
• Autolink, do zwrotu w rodzaju „oto nasza strona z dokumentacją“, gdy chcesz, aby adres URL był widoczny zarówno jako tekst, jak i jako cel.

Higiena znaków specjalnych

• Spacje w adresach URL wymagają %20, w przeciwnym razie link urwie się na spacji.
• Nawiasy okrągłe w adresie URL wymagają zakodowania jako %28 i %29, w przeciwnym razie parser Markdown je pochłonie.
• Nawiasy kwadratowe w tekście odnośnika trzeba wyeskejpować jako \[ i \], aby parser nie potraktował ich jako zagnieżdżonej składni linku.

Wskazówki dotyczące dostępności

• Unikaj „kliknij tutaj“. Tekst odnośnika w rodzaju kliknij tutaj lub czytaj więcej jest bezużyteczny, gdy użytkownicy czytników ekranu przechodzą między linkami klawiszem Tab. Używaj opisowego tekstu: [przewodnik instalacji](...).
• Nie umieszczaj samego adresu URL jako tekstu odnośnika dla długich adresów URL, jest to nieprzyjazne dla technologii wspomagających i brzydko wygląda w druku.
• „Otwórz w nowej karcie“ to surowy kod HTML (target="_blank"), a nie Markdown. Większość mechanizmów renderujących akceptujących surowy HTML uwzględni to; czysty CommonMark nie.

Skrót w jednym wierszu

W komentarzach na GitHubie wklejenie adresu URL obok zaznaczonego tekstu automatycznie zamienia go w link Markdown. Przydatne, gdy już jesteś w edytorze.