Markdown wyjaśniony w 5 minut
Prawdopodobnie używałeś Markdown, nie wiedząc o tym. Kiedykolwiek wpisałeś **pogrubienie** w wiadomości na Slacku? Napisałeś README na GitHubie? Sformatowałeś post na Reddicie? To jest Markdown.
Markdown to lekki sposób formatowania zwykłego tekstu za pomocą prostych symboli. Zamiast klikania przycisków na pasku narzędzi dla pogrubienia, kursywy, nagłówków i list, wpisujesz kilka znaków wskazujących żądane formatowanie. Został stworzony w 2004 roku przez Johna Grubera i Aarona Swartza, a od tego czasu stał się domyślnym językiem formatowania dla programistów, pisarzy i każdego, kto pracuje z tekstem w internecie.
Dlaczego Markdown istnieje
Przed Markdown formatowanie tekstu dla sieci oznaczało pisanie HTML. Aby pogrubić słowo, wpisywałeś <strong>pogrubienie</strong>. Aby stworzyć listę, potrzebowałeś <ul><li>element</li></ul>. HTML jest potężny, ale rozwlekły i trudny do czytania w surowej formie.
Markdown rozwiązuje to, zapewniając skrót czytelny dla ludzi. Surowy tekst jest łatwy do czytania nawet przed renderowaniem. Sformatowane wyjście jest czyste i profesjonalne.
Czy wiesz, że? Filozofia projektowa Markdown zakłada, że surowy tekst powinien być „publikowalny sam w sobie, jako zwykły tekst, bez wrażenia, że został otagowany lub opatrzony instrukcjami formatowania." Dlatego składnia Markdown używa znaków, które wizualnie sugerują formatowanie, jakie produkują.
Podstawowa składnia
Oto wszystko, co musisz wiedzieć, aby zacząć produktywnie używać Markdown.
Nagłówki
Użyj symboli hash (#) do tworzenia nagłówków. Więcej hashów oznacza mniejsze nagłówki.
# Nagłówek 1 (największy)
## Nagłówek 2
### Nagłówek 3
#### Nagłówek 4
Pogrubienie i kursywa
Otocz tekst gwiazdkami lub podkreśleniami:
**pogrubiony tekst**
*tekst kursywą*
***pogrubiony i kursywa***
Listy
Listy nieuporządkowane używają myślników, gwiazdek lub plusów. Listy uporządkowane używają numerów.
- Pierwszy element
- Drugi element
- Trzeci element
1. Pierwszy krok
2. Drugi krok
3. Trzeci krok
Linki
Nawiasy kwadratowe dla tekstu, okrągłe dla URL:
[Kliknij tutaj](https://example.com)
Obrazy
Jak linki, ale z wykrzyknikiem z przodu:
Cytaty
Użyj znaku większości:
> To jest cytat. Będzie wcięty i inaczej ostylowany.
Kod
Odwrotne apostrofy dla kodu w linii, potrójne dla bloków kodu:
Użyj funkcji `print()` do wypisania tekstu.
Tabele
Użyj pionowych kresek i myślników:
| Imię | Rola | Lokalizacja |
| --- | --- | --- |
| Alicja | Programistka | Berlin |
| Jan | Projektant | Londyn |
Gdzie używany jest Markdown
Markdown jest wszędzie:
Tworzenie oprogramowania
- GitHub, GitLab, Bitbucket: README, zgłoszenia, pull requesty i dokumentacja są pisane w Markdown.
- Stack Overflow: Pytania i odpowiedzi używają formatowania Markdown.
- Dokumentacja kodu: Wiele generatorów dokumentacji (Docusaurus, MkDocs, Jekyll) używa Markdown jako formatu źródłowego.
Komunikacja
- Slack: Obsługuje podzbiór Markdown do formatowania wiadomości.
- Discord: Używa Markdown do pogrubienia, kursywy, bloków kodu i więcej.
- Reddit: Posty i komentarze są formatowane za pomocą Markdown.
Pisanie i publikowanie
- Blogi: Wiele generatorów stron statycznych używa plików Markdown jako źródeł treści.
- Książki: Kilka narzędzi wydawniczych akceptuje manuskrypty w Markdown.
- Notatki: Aplikacje jak Obsidian, Notion, Bear i Typora są zbudowane wokół Markdown.
Wskazówka Możesz podglądać i ćwiczyć Markdown już teraz, za darmo, w przeglądarce: Pisz w Markdown. Zobacz sformatowane wyjście w czasie rzeczywistym podczas pisania.
Odmiany Markdown
Warto wiedzieć, że istnieją różne „odmiany" Markdown. Podstawowa składnia jest taka sama wszędzie, ale niektóre platformy dodają rozszerzenia:
| Odmiana | Dodatkowe funkcje | Używane przez |
|---|---|---|
| CommonMark | Ścisła specyfikacja | Standard ogólny |
| GitHub Flavored Markdown (GFM) | Listy zadań, tabele, przekreślenie, automatyczne linkowanie | GitHub |
| MultiMarkdown | Przypisy, cytaty, metadane | Pisanie akademickie |
| R Markdown | Osadzony kod R, analiza danych | Data science |
Częste błędy
Zapominanie pustych linii
Markdown wymaga pustej linii przed i po wielu elementach. Nagłówek wymaga pustej linii przed sobą. Lista wymaga pustej linii przed i po. Zapominanie tych pustych linii jest najczęstszą przyczyną problemów z renderowaniem.
Niespójne znaczniki list
Mieszanie -, * i + w tej samej liście może powodować nieoczekiwane renderowanie. Wybierz jeden i trzymaj się go.
Spacje po symbolach
Niektóre procesory Markdown wymagają spacji po # w nagłówkach i po - w listach. Zawsze dołączaj spację, żeby być bezpiecznym.
Uwaga Markdown nie obsługuje wszystkich potrzeb formatowania. Jeśli potrzebujesz złożonych układów, kolorowego tekstu, precyzyjnej typografii lub dokumentów gotowych do druku, możesz potrzebować HTML, LaTeX lub edytora tekstu. Markdown najlepiej nadaje się do treści strukturalnych, skoncentrowanych na tekście.
Dlaczego warto nauczyć się Markdown
Markdown zajmuje pięć minut nauki i oszczędza godziny z upływem czasu. Gdy go poznasz, możesz:
- Pisać dokumentację, która pięknie renderuje się na GitHubie
- Formatować wiadomości w Slacku i Discordzie bez dotykania myszki
- Robić strukturalne notatki przenośne między aplikacjami
- Tworzyć posty blogowe i treści webowe ze zwykłych plików tekstowych
Stosunek inwestycji do zwrotu jest jednym z najlepszych w całym świecie technologii.
Zacznij pisać w Markdown teraz:
Za darmo, w przeglądarce, z podglądem w czasie rzeczywistym podczas pisania.