Markdown – GitHub MarkDOWN, cheat sheet, link, table, image, …

Markdown – GitHub

Markdown to lekki język znaczników, który można używać do dodawania elementów formatowania do dokumentów tekstowych w postaci zwykłego tekstu. Jego celem jest łatwość w odczytywaniu i pisaniu. Za pomocą kilku znaczników pomoże nam podrasować wygląd tekstu, tak aby był bardziej przyjazny dla oka.

Markdown – wprowadzenie

Z tego materiału dowiesz się:

  • Czym jest Markdown?
  • Jaka jest składnia w Markdown’ie?
  • Czy można stosować Markdown w GitHubie?

Markdown

Markdown to lekki język znaczników, który można używać do dodawania elementów formatowania do dokumentów tekstowych w postaci zwykłego tekstu. Markdown jest obecnie jednym z najpopularniejszych języków znaczników na świecie. Jest on szeroko stosowany m.in. w komunikatorach, forach internetowych, stronach www, dokumentacji i plikach readme.

Używanie Markdown różni się od takich aplikacji jak np. Microsoft Word, w której klikasz przyciski, aby sformatować słowa i frazy, a zmiany są widoczne natychmiast. Natomiast kiedy tworzysz plik w formacie Markdown, dodajesz składnię Markdown do tekstu, aby wskazać, które słowa i frazy powinny wyglądać inaczej.

Przykład Markdown

Fragment markdown:

# Nagłówek

Zostanie zamieniony na następujący kod HTML:

<h1>Nagłówek</h1>

Kilka ciekawych faktów na temat Markdown’u:

  • Twórcami są John Gruber i Aaron Swartz.
  • Markdown został stworzony w 2004 roku.
  • Oryginalnie został zaimplementowany w Perlu.
  • W 2014 r. udostępniono jednoznaczną specyfikację i zestaw testów dla Markdown.

Markdown | Markdown tutorial

Markdown cechuje prostota, która zwiększa czytelność, jak i ułatwia pisanie tekstu. Wszystko fajnie, ale pewnie zastanawiasz się, po co Ci tak właściwie Markdown? 🙃

Istnieją dość dobrze rozwinięte edytory tekstów, w których za jednym kliknięciem możesz szybko sformatować kod. Jest kilka powodów, dla których duża grupa osób wybiera właśnie Markdown:

  • Popularność – markdown stosuję się naprawdę w wielu miejscach, gdzie tworzy się tekst. Przykładowo jest używany do tworzenia stron internetowych, dokumentów, notatek, książek, prezentacji, wiadomości e-mail oraz dokumentacji technicznej. Są to elementy tak naprawdę, z których korzysta praktycznie każdy, kto obecnie nie żyje w jaskini pośrodku niczego 😏
  • Pliki zawierające tekst w formacie Markdown można otwierać za pomocą praktycznie dowolnej aplikacji. Jeśli uznasz, że nie podoba Ci się aktualnie używana aplikacja Markdown, możesz zaimportować swoje pliki Markdown do innej aplikacji Markdown. Stanowi to wyraźny kontrast z aplikacjami do przetwarzania tekstu, takimi jak Microsoft Word, które blokują zawartość w zastrzeżonym formacie pliku.
  • Markdown jest niezależny od platformy. Tekst w formacie Markdown można tworzyć na dowolnym urządzeniu z dowolnym systemem operacyjnym.
  • Obecnie wiele aplikacji oraz witryn internetowych obsługuję Markdown m.in. takie witryny jak Reddit czy GitHub.

Powyższe argumenty oraz łatwość użytkowania Markdown’u sprawiają, że z przyjemnością z niego korzystam w codziennej pracy.

Markdown editor

Istnieje sporo możliwości, jeżeli chodzi o wybór edytora Markdown’u. Wszystko tak naprawdę zależy od Twoich osobistych preferencji. Przykładowo – możesz użyć Visual Studio Code, Typora lub iA Writer, czy IntelliJ Idea – czyli naszego popularnego IDE.

Markdown cheat sheet | Ściągawka

Kiedy zaczynasz używać Markdown’u dobrze mieć małą ściągawkę, do której można zajrzeć w każdej chwili. Poniżej znajdziesz taką właśnie ściągawkę, która pomoże Ci w przyswojeniu elementów składni Markdown. Sam Markdown również udostępnia nam naprawdę przystępną i zrozumiała dokumentację, do której warto zajrzeć.

Markdown syntax | Składnia

Liczba opcji formatowania w Markdown jest dosyć ograniczona. Warto dlatego jest się nauczyć na pamięć, co niewątpliwie przyspieszy proces tworzenia i formatowania praktycznie dowolnego tekstu.

Markdown heading | Nagłówek

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

Markdown – Markdown syntax Markdown nagłówek

Markdown bold | Pogrubienie

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

  • **<tekst>** np. **Hello**,
  •  __<tekst>__ np. __Hello_.

Markdown – Markdown syntax Markdown bold

Markdown italic | Kursywa

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

  • *<tekst>* np. *Hello*,
  • _<tekst>_ np. _Hello_.

Markdown – Markdown syntax Markdown italic

Markdown bold & italic | 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ć:

  • ***<tekst>*** np. ***Hello***,
  • ___<tekst>___ np. ___Hello___,
  • __*<tekst>*__ np. __*Hello*__,
  • **_<tekst>_** np. **_Hello_**.

Markdown – Markdown syntax Markdown bold italic

Markdown blockquote | Cytat

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

Markdown list | Lista

Lista uporządkowana (ang. ordered list)

Jeżeli chcesz 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. <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.

 

Markdown – Markdown syntax Markdown list

 

Istnieje również możliwość stworzenia zagnieżdżonej listy:

Markdown – Markdown syntax Markdown list

Lista nieuporządkowana (ang. unordered list)

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

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

Markdown – Markdown syntax Markdown unordered list

Analogicznie jak w przypadku listy uporządkowanej i w tym przypadku możesz stworzyć zagnieżdżoną listę.

Lista z zadaniami (ang. task list)

Ciekawą opcją jest możliwość tworzenia tzw. task lists. Aby utworzyć taką listę, musisz dodać przed elementem listy – [x] lub – []:

  • – [x] <zadanie> (jeżeli task jest wykonany), – [] <zadanie> (jeżeli task nie został jeszcze wykonany) np.
    – [x] Zrobić zakupu,
    – [] Umyć naczynia.

Markdown – Markdown syntax Markdown task list

Markdown code | Kod

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

Markdown – Markdown syntax Markdown code

Markdown horizontal | Pozioma linia

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

Markdown – Markdown syntax Markdown horizontal

Markdown link

Chcąc dodać link, należy użyć [<nazwa>](<url>)
np. [StormIt](https://www.stormit.pl).

Markdown image | Zdjęcie

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

Markdown new line | Nowa linia

Chcąc dodać tekst w nowej linii, nie wystarczy pojedynczy enter.
Aby rozpocząć tekst w nowej linii, zastosuj podwójny enter lub html’owy znacznik <br>.

Markdown table | 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.

Markdown – Markdown syntax Markdown table

Możliwe jest również wyjustowanie tekstu. Aby to zrobić zamiast | ———– | zastosuj jedną z opcji:

  • | :—       | – Wyjustowanie do lewej,

  • :—-:   | – Wyśrodkowanie,

  • |       —: | – Wyjustowanie do prawej.

Nie musisz koniecznie ustawiać jednej opcji dla całej tabeli. Możesz również modyfikować pojedyncze kolumny.

Markdown comment | Komentarz

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

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

Markdown – Markdown syntax Markdown comment

 

Github Markdown

GitHub to bardzo wszechstronne narzędzie, które ciągle się rozwija. Posiada on również w swojej „ofercie” możliwość korzystania z Markdown’u.

GitHub łączy składnię do formatowania tekstu o nazwie GitHub Flavored Markdown z kilkoma unikalnymi funkcjami pisania.

Oprócz formatowania Markdown takiego jak pogrubienie i kursywa oraz tworzenie nagłówków, linków i list, pasek narzędzi zawiera funkcje specyficzne dla GitHub, takie jak @wzmianki, listy zadań oraz linki do problemów (ang. issues) i pull request’ów.

GitHub umożliwia włączenie czcionki o stałej szerokości w każdym polu komentarza w serwisie GitHub. Każdy znak w czcionce o stałej szerokości zajmuje tę samą przestrzeń poziomą, co może ułatwić edycję zaawansowanych struktur Markdown, takich jak tabele i fragmenty kodu.

Aby włączyć opcję stałej szerokości czcionki na swoim koncie GitHub, musisz udać się do zakładki ustawień (ang. settings).

Markdown – Markdown syntax Markdown GitHub

Następnie wejdź do zakładki wyglądu (ang. appearance).

Markdown – Markdown syntax Markdown GitHub

W ostatni, kroku musisz odhaczyć opcję dot. czcionki i już od teraz możesz korzystać z tej funkcjonalności.

Markdown – Markdown syntax Markdown GitHub

W tym materiale tylko wspominam o GitHub’ie w kontekście Markdown’u. Jeżeli nie masz jeszcze konta na GitHub’ie lub chciałbyś bliżej zapoznać się z tym narzędziem, to zapraszam do poniższego wpisu:

➡ ZOBACZ 👉: GitHub tutorial | GitHub desktop, GitHub actions

Markdown – podsumowanie

W ramach tego materiału zapoznaliśmy się z tematem Markdown. Poznaliśmy również składnię Markdown’u, która przyda Ci się w codziennej pracy z tekstem.

Jeżeli spodobał Ci się ten materiał lub jeśli dopiero co zaczynasz swoją przygodę z programowaniem i chcesz dobrze wejść w świat deweloperów, zapraszam Cię do zapoznania się z moim programem dotyczącym Javy:

➡ ZOBACZ 👉: Java od podstaw


Jak zostać programistą

8 rzeczy, które musisz wiedzieć, żeby dostać pracę jako programista.

Jak zostać programistą
No comments
Share:

Dodaj komentarz

Twój adres e-mail nie zostanie opublikowany.