Podsumowanie składni Markdown na GitHubie
Czym jest Markdown i jak, w kontekście hostowania bloga na GitHub Pages, korzystać z GitHub Flavored Markdown — najważniejsze zasady i składnia.
Aby wykorzystać GitHub Pages, trzeba znać składnię markdown. Tekst powstał na podstawie oficjalnej dokumentacji GitHub: Mastering Markdown oraz Basic writing and formatting syntax.
1. Czym jest Markdown
Markdown (markdown) to lekki język znaczników oparty na zwykłym tekście. Służy do tworzenia sformatowanych dokumentów w postaci zwykłego tekstu; w porównaniu z typowymi językami znaczników cechuje się prostą i łatwą składnią. Ponieważ można go łatwo konwertować do dokumentów sformatowanych, takich jak HTML czy Rich Text Format (RTF), jest często używany w plikach README dystrybuowanych wraz z oprogramowaniem oraz w publikacjach online.
John Gruber stworzył język Markdown w roku 12004 kalendarza holoceńskiego, we współpracy z Aaronem Swartzem w zakresie składni; celem było umożliwienie ludziom pisania w łatwym do czytania i łatwym do tworzenia formacie plain text, z opcjonalną konwersją do strukturalnie poprawnego XHTML (lub HTML).
2. Składnia Markdown
Markdown nie ma jednego ustalonego standardu, dlatego szczegółowa składnia może się nieco różnić w zależności od zastosowania. Składnia zebrana tutaj opiera się na GitHub Flavored Markdown.
2.1. Łamanie linii, podział na akapity
W Markdown pojedyncze naciśnięcie Enter nie jest traktowane jako złamanie linii.
1
2
3
Pierwsze zdanie.
Drugie zdanie.
Trzecie zdanie.
Pierwsze zdanie. Drugie zdanie. Trzecie zdanie.
Złamanie linii uzyskuje się, wpisując co najmniej dwie spacje z rzędu.
1
2
3
Pierwsze zdanie.
Drugie zdanie.
Trzecie zdanie.
Pierwsze zdanie.
Drugie zdanie.
Trzecie zdanie.
Akapity rozdziela się pustą linią (dwa razy Enter).
1
2
3
Jeden akapit.
Inny akapit.
Jeden akapit.
Inny akapit.
2.2. Nagłówki (Headers)
Łącznie jest 6 poziomów.
1
2
3
4
5
6
# This is an H1
## This is an H2
### This is an H3
#### This is an H4
##### This is an H5
###### This is an H6
Ponieważ tag H1 zasadniczo powinien występować na stronie tylko raz, zwykle przy pisaniu posta lub dokumentu rzadko używa się go bezpośrednio.
2.3. Wyróżnienia
1
2
3
4
5
6
7
8
9
10
11
*This text is italicized*
_This is italicized too_
**This is bold text**
__This is bold text too__
~~This was mistaken text~~
_You **can** combine them_
***All this text is important***
This text is italicized
This is italicized too
This is bold text
This is bold text too
This was mistaken text
You can combine them
All this text is important
2.4. Cytowanie tekstu
Używa się >.
1
2
3
> This is a first blockquote.
>> This is a second blockquote.
>>> This is a third blockquote.
This is a first blockquote.
This is a second blockquote.
This is a third blockquote.
2.5. Cytowanie kodu
Używa się ``` lub ~~~.
1
2
3
4
5
```
git status
git add
git commit
```
1
2
3
git status
git add
git commit
Można też wskazać język programowania, aby włączyć podświetlanie składni.
1
2
3
4
5
```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```
1
2
3
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
2.6. Linki
1
2
[GitHub Pages](https://pages.github.com/)
<https://pages.github.com/>
GitHub Pages
https://pages.github.com/
Można też używać linków względnych wskazujących na inne pliki w repozytorium. Sposób użycia jest taki sam jak w terminalu.
1
[README](../README.md)
2.7. Lista nieuporządkowana
Używa się - lub *.
1
2
3
- George Washington
- John Adams
- Thomas Jefferson
- George Washington
- John Adams
- Thomas Jefferson
2.8. Lista uporządkowana
Używa się numerów.
1
2
3
1. James Madison
2. James Monroe
3. John Quincy Adams
- James Madison
- James Monroe
- John Quincy Adams
2.9. Lista zagnieżdżona
1
2
3
1. First list item
- First nested list item
- Second nested list item
- First list item
- First nested list item
- Second nested list item
- First nested list item
2.10. Lista zadań (to-do)
Aby utworzyć listę zadań, dodaj [ ] przed każdym elementem. Aby oznaczyć zadanie jako wykonane, użyj [x].
1
2
3
- [x] Finish my changes
- [ ] Push my commits to GitHub
- [ ] Open a pull request
- Finish my changes
- Push my commits to GitHub
- Open a pull request
2.11. Wstawianie obrazów
1
2
3
4
Metoda: {(opcjonalnie)opcje dodatkowe}
{: .align-center}
{: width="50%" height="50%"}
2.12. Tworzenie tabel
Tabele można tworzyć za pomocą | oraz -. Przed tabelą należy zostawić jedną pustą linię, aby wyświetlała się poprawnie. Aby składnia została poprawnie rozpoznana, trzeba użyć co najmniej 3 znaków -.
1
2
3
4
5
| Left-aligned | Center-aligned | Right-aligned |
| :--- | :---: | ---: |
| git status | git status | git status |
| git diff | git diff | git diff |
| Left-aligned | Center-aligned | Right-aligned |
|---|---|---|
| git status | git status | git status |
| git diff | git diff | git diff |