Podgląd Markdown
Markdown to lekki język znaczników do tworzenia sformatowanego tekstu za pomocą składni czystego tekstu. Popularny w dokumentacji, plikach README i notatkach, renderuje się do HTML do wyświetlania. To narzędzie podgląda Markdown z renderowaniem na żywo, wyodrębnia strukturę dokumentu (nagłówki, linki, obrazy) i może konwertować do HTML.
Specyfikacje
Typowe zastosowania
- Podgląd plików README.md przed commitowaniem
- Przegląd formatowania dokumentacji
- Wyodrębnianie wszystkich linków z dokumentu do walidacji
- Konwersja Markdown do HTML do osadzania
- Analiza struktury dokumentu i nawigacji
Funkcje
- Podgląd na żywo z renderowaniem HTML
- Wyodrębnianie struktury dokumentu (nagłówki jako spis treści)
- Lista wszystkich linków i obrazów w dokumencie
- Wykrywanie i wyświetlanie bloków kodu z podpowiedziami języka
- Parsowanie frontmatter (metadane YAML)
- Konwersja do czystego wyjścia HTML
- Statystyki liczby słów i znaków
Przyklady
README z funkcjami
Wypróbuj →Typowy plik README projektu z nagłówkami, listami i kodem.
# My Project
A brief description of what this project does.
## Installation
```bash
npm install my-project
```
## Features
- **Fast** - Optimized for speed
- **Simple** - Easy to use API
- **Flexible** - Works with any framework
## Links
- [Documentation](https://docs.example.com)
- [GitHub](https://github.com/example/project)Wskazowki
- Użyj # dla nagłówków (# H1, ## H2, ### H3 itp.).
- Bloki kodu używają potrójnych grawisów z opcjonalnym identyfikatorem języka.
- Linki używają składni [tekst](url); obrazy używają .
- Frontmatter między liniami --- może zawierać metadane YAML.
Zrozumienie Podgląd Markdown
Markdown to lekki język znaczników stworzony przez Johna Grubera w 2004 roku, zaprojektowany tak, aby był czytelny jako czysty tekst, jednocześnie konwertując się czysto do HTML. Jego składnia używa znaków interpunkcyjnych, które wizualnie sugerują swoje formatowanie: # dla nagłówków, * dla wyróżnienia, - dla list i grawisy dla kodu. Pliki Markdown pozostają użyteczne nawet bez renderowania, dlatego format ten dominuje w dokumentacji, plikach README i pisaniu technicznym.
Specyfikacja CommonMark (2014) rozwiązała wiele niejednoznaczności oryginalnego Markdown. CommonMark precyzyjnie definiuje, jak obsługiwane są przypadki brzegowe, i większość nowoczesnych parserów ją implementuje. GitHub Flavored Markdown (GFM) rozszerza CommonMark o tabele, listy zadań, przekreślenie, automatycznie linkowane URL-e i ogrodzone bloki kodu z podświetlaniem składni.
GFM jest de facto standardem dla plików README, opisów pull requestów, komentarzy do issues i stron dokumentacji. Większość platform dokumentacyjnych (Notion, Docusaurus, MkDocs, GitBook) obsługuje GFM lub jego nadzbiór.
Frontmatter to powszechna konwencja dodawania ustrukturyzowanych metadanych do plików Markdown. Blok YAML ograniczony liniami --- na górze pliku może zawierać tytuł, datę, autora i tagi używane przez generatory stron statycznych (Astro, Hugo, Jekyll, Next.js) do budowania nawigacji i układów stron.
W praktyce "Markdown" prawie zawsze odnosi się do CommonMark lub GFM. Oryginalna specyfikacja Markdown pozostawiła wiele przypadków brzegowych niezdefiniowanych, a CommonMark rozwiązał te niejednoznaczności ścisłą specyfikacją. GFM rozszerza CommonMark o tabele, listy zadań, przekreślenie i automatycznie linkowane URL-e. Przy ocenie parsera lub renderera Markdown, sprawdzenie jego zgodności z CommonMark jest wiarygodnym wskaźnikiem, jak dobrze obsługuje przypadki brzegowe.
Tabele w GFM używają kresek pionowych (|) do rozdzielania kolumn i myślników (-) dla wiersza separatora nagłówka. Wyrównanie kolumn kontroluje się dwukropkami w separatorze: :--- dla wyrównania do lewej, :---: dla wyśrodkowania i ---: dla wyrównania do prawej. Tabele to rozszerzenie GFM i nie są częścią oryginalnej składni Markdown. Frontmatter, ograniczony liniami --- na samym początku pliku, to blok metadanych YAML używany przez generatory stron statycznych dla metadanych strony, takich jak tytuł, data, układ i tagi. GitHub renderuje frontmatter jako tabelę na górze pliku, choć nie wszystkie renderery go przetwarzają.
Ogrodzone bloki kodu używają potrójnych grawisów z opcjonalnym identyfikatorem języka po otwierających grawisach — na przykład linia z trzema grawisami, po których następuje "javascript", rozpoczyna blok JavaScript z podświetlaniem składni. Dostępne identyfikatory języków zależą od platformy renderującej. Wcięcie kodu o cztery spacje również tworzy blok kodu, ale bez możliwości określenia języka do podświetlania.