Przewodnik po składni Markdown
Przejrzysta ściąga po Markdown na co dzień. Każdy blok pokazuje składnię i wynik, jaki otrzymasz.
Czym jest Markdown?
Markdown to lekki sposób dodawania formatowania do zwykłego tekstu. Zamiast przycisków i menu używasz kilku prostych symboli, jak # dla nagłówka albo * dla wyróżnienia, które pozostają czytelne nawet jako surowy tekst.
Stworzony przez Johna Grubera i Aarona Swartza w 2004 roku, stał się standardem dla plików README, dokumentacji, notatek i serwisów takich jak GitHub czy Reddit. Ponieważ to zwykły tekst, Twoje teksty pozostają przenośne i czytelne wszędzie.
Ten przewodnik obejmuje składnię, której będziesz używać najczęściej. Otwórz dowolny przykład w Markdown Peek i naciśnij spację, aby przełączać się między źródłem a wyrenderowanym wynikiem.
Nagłówki
Zacznij linię od jednego do sześciu znaków #. Im więcej krzyżyków, tym mniejszy i głębszy nagłówek.
Markdown
# Heading 1 ## Heading 2 ### Heading 3 #### Heading 4
Wynik
Heading 1
Heading 2
Heading 3
Heading 4
Pogrubienie, kursywa i więcej
Otocz tekst symbolami, aby go wyróżnić. Możesz je dowolnie łączyć.
Markdown
**Bold text** *Italic text* ***Bold and italic*** ~~Strikethrough~~ `Inline code`
Wynik
Bold text
Italic text
Bold and italic
Strikethrough
Inline code
Listy
Użyj myślnika, gwiazdki albo plusa dla punktorów, a cyfr dla list numerowanych. Wcięcie tworzy zagnieżdżenie.
Markdown
- First item - Second item - Nested item - Third item 1. Step one 2. Step two
Wynik
- First item
- Second item
- Nested item
- Third item
- Step one
- Step two
Linki
Umieść widoczny tekst w nawiasach kwadratowych, a adres w nawiasach okrągłych.
Markdown
[Markdown Peek](https://markdownpeek.com) <https://markdownpeek.com>
Obrazy
Obraz to link poprzedzony wykrzyknikiem. Tekst w nawiasach kwadratowych to tekst alternatywny.
Markdown
Wynik
Cytaty blokowe
Zacznij linię od >, aby ją zacytować. Dodaj kolejne >, aby zagnieździć cytat w cytacie.
Markdown
> A quote worth remembering. > > > And a nested one.
Wynik
A quote worth remembering.
And a nested one.
Kod
Otocz kod w tekście pojedynczymi apostrofami odwrotnymi, a całe bloki potrójnymi, z opcjonalną nazwą języka.
Markdown
Use `backticks` for inline code.
```js
function hi() {
console.log("Hello");
}
```Wynik
Use backticks for inline code.
function hi() {
console.log("Hello");
}Tabele
Oddziel kolumny znakami pionowej kreski i podkreśl wiersz nagłówka myślnikami. Dwukropki ustawiają wyrównanie.
Markdown
| Feature | Supported | |---------|:---------:| | Tables | Yes | | Code | Yes |
Wynik
| Feature | Supported |
|---|---|
| Tables | Yes |
| Code | Yes |
Linie poziome
Trzy lub więcej myślników, gwiazdek albo podkreślników w osobnej linii rysuje separator.
Markdown
Above the line. --- Below the line.
Wynik
Above the line.
Below the line.
Listy zadań
Element listy z [ ] to zadanie otwarte, a z [x] to zadanie ukończone.
Markdown
- [x] Read the guide - [ ] Set as default app
Wynik
- Read the guide
- Set as default app
Escapowanie znaków
Umieść ukośnik wsteczny przed symbolem, aby pokazać go dosłownie zamiast jako formatowanie.
Markdown
\*Not italic\* \# Not a heading
Wynik
*Not italic*
# Not a heading
Wzory matematyczne w LaTeX
Otocz LaTeX pojedynczymi znakami dolara dla wzoru w zdaniu albo podwójnymi dla wzoru w osobnej linii. Markdown Peek renderuje oba warianty, offline.
Markdown
Inline math like $E = mc^2$ works in a sentence. $$ a^2 + b^2 = c^2 $$
Wynik
Inline math like E = mc2 works in a sentence.
a2 + b2 = c2
Diagramy w Mermaid
Otwórz blok kodu w ogrodzeniu z etykietą mermaid i opisz schemat blokowy albo diagram sekwencji zwykłym tekstem. Markdown Peek narysuje go za Ciebie, w trybie jasnym lub ciemnym.
Markdown
```mermaid flowchart LR A[Write] --> B[Preview] B --> C[Share] ```
Wynik
Czytaj Markdown pięknie na swoim Macu
Markdown Peek wyświetla dowolny plik .md w przejrzystym stylu GitHub, z Quick Look w Finderze i zapisem do PDF. Bezpłatna w Mac App Store.
