Autor: 05.06.2024
Markdown - przewodnik dla początkujących
Markdown to prosty język znaczników. Umożliwia łatwe konwertowanie tekstu do poprawnego kodu HTML. Markdown jest używany do tworzenia notatek, dokumentacji technicznej, w komunikatorach, na forach internetowych i nie tylko.
Składnia Markdown
Za pomocą markdown możesz bardzo łatwo tworzyć podstawowe elementy budujące treść. Popatrz na kilka przykładów.
Nagłówki
Nagłówek 1 poziomu będzie zaiwerał znak #, drugiego poziomu będzie zawierał ## itd. Spójrz na poniższy kod. Masz do dyspozycji aż 6 poziomów.
# Header 1
## Header 2
### Header 3
Rezultat działania kodu jest następujący:
Odnośniki
Wstawienie odnośnika w treści jest bardzo łatwe. Odnośniki tworzy się przy pomocy nawiasów kwadratowych dla tekstu i nawiasów okrągłych dla adresu url.
[google](https://google.com)
Rezultat jest następujący
Obrazy
Równie łatwo można wstawić w treści obrazy. Wstaw wykrzyknik, tekst alternatywny w nawiasie kwadratowym oraz url do obranka w nawiasie zwykłym
Rezultat jest następujący:
Listy
Bardzo łatwo możemy zapisywać listy w języku Markdown. Listy nieuporządkowane możemy tworzyć przy pomocy znaku "+" a listy numerowane nie różnia się praktycznie niczym od tradycyjnego zapisu - używamy po prostu kolejnych liczb.
Spójrz na przykładowe zastosowanie list:
+ one
+ two
+ three
1. Mike
2. John
3. Tom
Rzeultat jest następujący:
Formatowanie tekstu w Markdown
Teraz popatrz na sposoby formatowania tekstu w Markdown
Pogrubienie w języku Markdown możemy zastosować poprzez użycie dwóch znaków “_” pomiędzy interesującymi nas słowami w tekście, a kursywą polega na zastosowaniu pojedynczego znaku “_”. Spójrz na praktyczne zastosowanie opisanych znaków.
_My_ name is __John Doe__
Rezultat jest następujący:
Plik MD - jak edytować
Markdown pod wieloma względami przypomina zwykły tekst. Do pracy z tym językiem nie potrzeba żadnych wyrafinowanych narzędzi. Pliki zawierające Markdown mają rozszerzenie MD (przykłada: "readme.md")
Większość popularnych edytorów kodu wspiera składnię Markdown. Przykłady to Visual Studio Code, Subline Text, Atom, Notepad++. Markdown jest też wpierany przez wiele platform internetowych np. GitHub. Są także proste edytory online do pracy z tym językiem, chociażby popularny StackEdit.
Przykładowe zastosowania Markdown
Markdown często używa się do tworzenia dokumantacji dla projektów programistycznych. Za jego pomocą opisuje się repozytoria kodu w popularnym serwisie GitHub, dodaj się instrukcje dla użytkowników oraz inne ważne informacje.
Z Markdown korzystają także popularne serwisy oraz pltformy blogowe takie jak Medium, Ghost albo Jekyll.
Kolejne zastosowania to aplikacje do tworzenia notatek oraz listy rzeczy do zrobienia (and. to do list). Markdown jest także używany przez popularne komunikatory oraz narzędzia do pracy zespołowej takie jak Slack czy Trello.
Podsumowanie
Markdown to prosty i lekki język znaczników. Doskonale się sprawdza wszędzie tam, gfzie potrzeba prostego sposobu na formatowanie tekstu. Z tego powodu jest często używany do tworzenia dokumantacji, notatek oraz tekstowych wiadomości.
