CDRN

Konwertuj i wyświetl podgląd Markdown

  • Panel
  • Dokumentacja
  • API
konwertuje Twój Markdown na HTML i wyświetla podgląd na żywo, idealny do pisania plików README, dokumentacji lub artykułów

Czym jest Markdown?

Markdown to lekki język znaczników stworzony przez Johna Grubera w 2004 roku. Pozwala pisać sformatowany tekst przy użyciu prostej i czytelnej w surowej postaci składni, która następnie jest konwertowana na HTML.

To narzędzie wykorzystuje specyfikację GFM (GitHub Flavored Markdown), najbardziej rozpowszechniony wariant, który dodaje obsługę tabel, pól wyboru, bloków kodu z kolorowaniem składni oraz automatycznych odnośników.

Podgląd po prawej stronie aktualizuje się w czasie rzeczywistym podczas pisania. Przycisk Wyślij generuje odpowiadający kod HTML, który możesz skopiować lub pobrać.

Podstawowa składnia Markdown

MarkdownWynik
# Nagłówek 1Nagłówek <h1>
## Nagłówek 2Nagłówek <h2>
**pogrubienie**pogrubienie
*kursywa*kursywa
`kod w wierszu`kod w wierszu
```php ... ```Blok kodu PHP
[tekst](url)Hiperłącze
![alt](url)Obraz
- elementLista nieuporządkowana
1. elementLista uporządkowana
> cytatBlockquote
---Linia pozioma

Typowe zastosowania

  • README GitHub: pisanie dokumentacji projektu open source.
  • Dokumentacja techniczna: tworzenie przewodników, wiki lub stron dokumentacji (MkDocs, Docusaurus, Hugo).
  • Artykuły na blogu: większość systemów CMS (Jekyll, Ghost, Contentful) akceptuje Markdown.
  • Komentarze i zgłoszenia: GitHub, GitLab, Jira, Notion i Slack obsługują GFM.
  • Sformatowane e-maile: konwersja Markdown na HTML w celu osadzenia w wiadomości HTML.
  • Notatki i prezentacje: Obsidian, Notion, Marp i Reveal.js korzystają z Markdown.

Często zadawane pytania

Jaka jest różnica między standardowym Markdown a GFM?

Standardowy Markdown (CommonMark) obejmuje podstawowe elementy: nagłówki, listy, odnośniki, kod. GFM (GitHub Flavored Markdown) dodaje tabele, listy zadań (- [ ] element), kod ujęty w ogrodzenie z określeniem języka (```php), wzmianki oraz automatyczne odnośniki. To narzędzie wykorzystuje GFM za pośrednictwem biblioteki league/commonmark.

Czy wygenerowany kod HTML jest bezpieczny?

Tak. Konwerter jest skonfigurowany tak, aby usuwać surowe znaczniki HTML (html_input: strip) i blokować niebezpieczne odnośniki, co zapobiega atakom XSS. Wytworzony kod HTML nadaje się do osadzenia w istniejącej stronie internetowej.

Czy mogę umieścić kod HTML w moim Markdown?

Ze względów bezpieczeństwa surowy kod HTML wstawiony do Markdown jest usuwany podczas konwersji. Jeśli potrzebujesz niestandardowego renderowania HTML, napisz docelowy kod HTML bezpośrednio.

Jaki jest maksymalny rozmiar dokumentu?

Nie ma sztywnego limitu po stronie serwera dla tego narzędzia. W przypadku bardzo długich dokumentów (powyżej kilku tysięcy wierszy) podgląd w czasie rzeczywistym może zwolnić w zależności od Twojej przeglądarki.

Przykładowe zapytanie

curl -X POST https://cdrn.fr/api/v1/tools/markdown-formatter/execute \
  -H "Content-Type: application/json" \
  -d '{"input":"..."}'

Schemat wejściowy

Pole Typ Wymagane Domyślnie
input text –

Punkty końcowe

  • GET https://cdrn.fr/api/v1/tools - lista wszystkich dostępnych narzędzi
  • GET https://cdrn.fr/api/v1/tools/markdown-formatter - zwraca schemat dla tego narzędzia
  • POST https://cdrn.fr/api/v1/tools/markdown-formatter/execute - uruchamia to narzędzie z payloadem JSON