1. Co to jest Markdown?

Markdown to lekki język znaczników, którego można używać do dodawania elementów formatujących do dokumentów zawierających zwykły tekst. Stworzony przez Johna Grubera w 2004 roku, Markdown jest obecnie jednym z najpopularniejszych języków znaczników na świecie. Tworząc plik w formacie Markdown, dodajemy składnię Markdown do tekstu, aby wskazać, które słowa i frazy powinny wyglądać inaczej.

Na przykład, aby oznaczyć nagłówek, należy dodać przed nim znak liczby (np # Heading One. ). Aby pogrubić frazę, dodać przed nią i po niej dwie gwiazdki (np this text is bold. ). Przyzwyczajenie się do składni Markdown w tekście może zająć trochę czasu, zwłaszcza jeśli jesteśmy przyzwyczajony do aplikacji WYSIWYG. Poniższy zrzut ekranu przedstawia plik Markdown wyświetlany w edytorze tekstu Visual Studio Code.

Możemy dodać elementy formatowania Markdown do zwykłego pliku tekstowego za pomocą edytora tekstu. Możemy też użyć jednej z wielu aplikacji Markdown dla systemów operacyjnych macOS, Windows, Linux, iOS i Android. Istnieje również kilka aplikacji internetowych zaprojektowanych specjalnie do pisania w języku Markdown.

W zależności od używanej aplikacji podgląd sformatowanego dokumentu w czasie rzeczywistym może nie być możliwy. Ale to dobrze. Według Grubera składnia Markdown została zaprojektowana tak, aby była czytelna i dyskretna, więc tekst w plikach Markdown można odczytać, nawet jeśli nie jest renderowany.

2. Dlaczego warto używać Markdown?

Istnieje kilka powodów, dla których ludzie używają Markdown zamiast edytorów WYSIWYG:

1. Markdown może być używany do wszystkiego. Ludzie używają go do tworzenia stron internetowych, dokumentów, notatek, książek, prezentacji, wiadomości e-mail i dokumentacji technicznej.
2. Markdown jest przenośny. Pliki zawierające tekst w formacie Markdown można otwierać za pomocą praktycznie dowolnej aplikacji. Jeśli nie spodoba się aplikacja Markdown, której aktualnie używamy, możemy zaimportować swoje pliki Markdown do innej aplikacji Markdown. Stoi to w wyraźnej sprzeczności z aplikacjami do edycji tekstu, takimi jak Microsoft Word, które blokują treść w zastrzeżonym formacie pliku.
3. Markdown jest niezależny od platformy. Możemy tworzyć tekst w formacie Markdown na dowolnym urządzeniu z dowolnym systemem operacyjnym.
4. Markdown jest przyszłościowy. Nawet jeśli aplikacja, z której korzystamy, przestanie działać w pewnym momencie w przyszłości, nadal będziemy mógli czytać tekst w formacie Markdown za pomocą aplikacji do edycji tekstu. Jest to ważna kwestia, jeśli chodzi o książki, prace uniwersyteckie i inne ważne dokumenty, które muszą być przechowywane przez czas nieokreślony.
5. Markdown jest wszędzie. Strony internetowe, takie jak Reddit i GitHub, obsługują Markdown, a obsługuje go wiele aplikacji komputerowych i internetowych.

3. Do czego służy Markdown?

Markdown to szybki i łatwy sposób robienia notatek, tworzenia treści na stronę internetową i tworzenia dokumentów gotowych do druku.

Nauka składni języka Markdown nie zajmuje dużo czasu, a gdy już wiemy, jak go używać, możemy pisać przy użyciu języka Markdown niemal wszędzie. Większość ludzi używa Markdown do tworzenia treści w Internecie, ale Markdown jest dobry do formatowania wszystkiego, od wiadomości e-mail po listy zakupów.

4. Przykłady używania języka Markdown

Język Markdown bazuje na rozmaitych znacznikach, które muszą pojawić się przed danym wierszem tekstu lub na początku i końcu danego fragmentu artykułu. Poniżej znajduje się lista najbardziej przydatnych znaczników.

4.1. Nagłówek Aby uzyskać nagłówek, należy zastosować # co będzie równe H1, ## to H2 itd. np. #Hello lub ##Hello.

4.2. Pogrubienie

W celu pogrubienia tekstu należy zastosować jedną z poniższych opcji:

1
2
**tekst** np. **Hello**
__tekst__ np. __Hello_

4.3. Kursywa

Aby uzyskać kursywę tekstu, należy zastosować jedną z poniższych opcji:

1
2
*tekst* np. *Hello*
_tekst_ np. _Hello_

4.4. Pogrubienie z kursywą

Możliwa jest również sytuacja, w której chcemy zarówno pogrubić tekst, jak i nadać mu kursywę. W tym przypadku mamy kilka możliwości, aby to zrobić:

1
2
3
4
1. ***tekst*** np. ***Hello***
2. ___tekst___ np. ___Hello___
3. __*tekst*__ np. __*Hello*__
4. **_tekst_** np. **_Hello_**

4.4. Cytat

1
Jeżeli chcemy w tekście stworzyć tzw. blok cytatu (ang. blocquote), musimy dodać > <tekst> np. > Być albo nie być. Blok cytatu powoduje dodanie charakterystycznego wcięcia z lewej strony.

4.5. Lista uporządkowana

Jeżeli chcemy w tekście stworzyć listę uporządkowaną, wystarczy, że postąpisz według poniższego schematu:

1
<tekst> następnie 2.<tekst> itd. np. 1. Pierwszy, 2. Drugi

Alternatywnie możesz nawet wypisać kolejne punkty jako:

1
2
1.<tekst> 1.<tekst> 1.<tekst> np. 1. Pierwszy, 1. Drugi, 1. Trzeci
1.<tekst> 5.<tekst> 7.<tekst> np. 1. Pierwszy, 5. Drugi, 7. Trzeci

Efekt końcowy będzie taki sam – lista sformatuje się poprawnie, wyliczając po kolei elementy.

4.6. Lista nieuporządkowana

Jeżeli chcemy w tekście stworzyć listę nieuporządkowaną, musisz dodać odpowiedni symbol do każdej kolejnej linii, która ma tworzyć listę:

1
2
3
–<tekst> następnie -<tekst> itd. np. – Pierwszy, – Drugi
+<tekst> następnie +<tekst> itd. np. +Pierwszy, +Drugi
*<tekst> następnie *<tekst> itd. np. *Pierwszy, *Drugi

4.7. Kod

1
Aby dodać do tekstu fragment kodu, wystarczy użyć `<code>` np. `int i = 1;`.

4.8. Pozioma linia

1
Aby utworzyć poziomą linię, należy użyć — lub ***.

4.9. Zdjęcie

Dodanie zdjęcia jest zbliżone do dodawania linku:
![<alt-tekst>](<zdjęcie>)
np. ![Markdown image](Markdown.jpg)

4.10. Tabela

Stworzenie tabeli w Markdown’ie wymaga trochę więcej pracy. Kolumnę wyznacza się, używając ||. Aby wyznaczyć nowy wiersz, wystarczy w nowej linii stworzyć kolejną kolumnę. Jeżeli chcesz oznaczyć pierwszy wiersz jako nagłówek, musisz oddzielić go od kolejnego wiersza | ———– |.

Tabela dostosowuje swój rozmiar automatycznie do treści.

4.11. Komentarz

Zdarzają się sytuacje, kiedy chcemy pozostawić komentarz, który ma nie być widoczny, wtedy można wykorzystać jedną z poniższych opcji:

1
2
[comment]: <> (<komentarz>) np. [comment]: <> (Jestem komentarzem).
[//]: <> (<komentarz>) np. [//]: <> (Jestem komentarzem).

Literatura: https://stormit.pl/markdown/