Markdown

Zawartość

Dzisiaj chciałbym napisać co nieco o Markdown. Nim jednak zacznę, trochę wprowadzenia.

Otóż, gdy moja strona bazowała na WordPress, używałem w nim wbudowanego klasycznego edytora, który z czasem został zastąpiony przez Gutenberg. Całość bazowało na ideologii z edytorów tekstu takich jak Word. Mieliśmy do dyspozycji przyciski do pogrubienia tekstu, wyśrodkowania, zmiany koloru itp.. Wszystko pięknie.

O ile wizualnie wszystko wyglądało ok, oprócz programu docelowego, każdy inny program wyświetlał tekst nieco inaczej.

W momencie przejścia na Hugo zmieniłem mój sposób pisania.

Ograniczyłem wszelkie elementy, które powodowałyby rozproszenie podczas zbierania myśli. Dlatego też wybrałem iA Writer do tworzenia moich tekstów (jeżeli szukasz alternatywy, spróbuj Typora , którego używam w systemie Windows).

iA Writer (czy też Typora) witają cię z czystą “kartką” papieru, na którą wylewasz swój tekst.

Oprócz mrugającego kursora nie ujrzysz tam przycisków do formatowania tekstu. Całe pisanie odbywa się za pomocą “Markdown”. W pewnym sensie możesz powiedzieć, że piszesz za pomocą kodu. Na szczęście ten “kod” jest bardzo prosty w przyswojeniu i ogranicza się do kilkunastu elementów, z których tak naprawdę będziesz używał tylko kilku podstawowych.

Markdown jest potężnym narzędziem, które również zostaje dostrzeżone przez twórców WordPress/Gutenberg, który obsługuje blok, gdzie możemy pisać lub też wkleić tekst napisany w ten właśnie sposób.

W internecie znajdziesz sporo odmian Markdown, jednakże każde z nich opiera się na tych samych zasada, w związku z tym, gdy znasz podstawy jego używania, jesteś gotowy wybrać program go używający, który najbardziej ci odpowiada.

Różnica pomiędzy iA Writer a Typora jest w tym, że w iA Writer domyślnie piszesz w Markdown. Aby wyświetlić twój tekst, w taki sposób, jaki będzie wyświetlany, chociażby na stronie internetowej, musisz kliknąć przycisk podglądu.

Typora używa Markdown i automatycznie przekształca go w aktywny podgląd.

Zaczynając pisać tytuł wpisu od # po przejściu do następnej linijki, mamy aktywny podgląd jak to wszystko mniej więcej będzie wyglądać.

Niektórzy wolą jedno, inni drugie.

Podczas pisania nie przeszkadza mi podejście żadnego z programów. W trakcie tworzenia Typora może być bardziej użyteczna, jednakże niż mój tekst skończę i wstawię na stronę, wolę przejrzeć wszystko w iA Writer (lub też w Typora nacisnąć Ctrl+/ aby przełączyć się w tryb kodu).

Przewagą iA Writer jest fakt dostępności aplikacji na platformy mobilne, dzięki czemu zaczynając pisać na komputerze, możemy kontynuować na komórce lub tablecie.

Dlaczego pisać z wykorzystaniem Markdown?

Otóż, otwórz sobie tekst napisany w Wordzie sprzed kilku lat, oraz tekst, który napiszesz teraz.

Oba te dokumenty — ich zawartość wygląda inaczej. Nagłówki są innej czcionki, sama czcionka może być inna, odstępy nie takie. I tak dale, i tak dalej.

Cały sens pisania w jednym formacie jest to, że tekst napisany kilka lat temu po wyświetleniu będzie wyglądał spójnie do tekstu, który napiszesz dzisiaj.

Od czego zacząć?

Aby zacząć, należy poznać, jak Markdown jest skonstruowany.

W tym celu możesz posłużyć się ściągawką , lub przeczytaj dalej.

A więc zacznijmy.

Nagłówki

Tak jak Word posiada Nagłówki (Headings), które wyświetlają tekst w różnych wyróżniających czcionkach, tak samo jest w przypadku Markdown.

Zaczynamy od napisania tytułu wpisu poprzedzonego symbolem hash # (Nagłówek pierwszego poziomu — główny, H1)

# Tytuł naszego wpisy

Każde kolejne nagłówki w naszym tekście wprowadzamy jako ##, nagłówek drugiego poziomu — H2, ###, nagłówek trzeciego poziomu — H3, i tak dalej.

## Pod tytuł — drugi poziom
### Trzeci poziom

I tak aż do poziomu szóstego — H6.

Pogrubienie tekstu

Aby pogrubić tekst, wystarczy poprzedzić go, oraz zakończyć podwójną gwiazdką **.

Tekst **pogrubiony**

aby uzyskać: Tekst pogrubiony

Pochylenie tekstu (kursywa)

Aby pochylić tekst, wystarczy poprzedzić go, oraz zakończyć pojedynczą gwiazdką *.

Tekst *pochylony*

aby uzyskać: Tekst pochylony

Cytat

Aby wyróżnić tekst w postaci cytatu, wystarczy poprzedzić go znakiem >.

> Tekst cytowany

aby uzyskać:

Tekst cytowany

Lista

Aby wprowadzić listę, wyliczankę czy też wypunktowanie (jak zwał tak zwał) wystarczy zdecydować się, czy chcemy listę numerowaną (wówczas zaczynamy od numerów), czy wypunktowaną (wówczas poprzedzamy tekst znakiem myślnika -).

Lista numerowana

1. Tekst pierwszy
2. Tekst drugi
2. Tekst trzeci

aby uzyskać:

  1. Tekst pierwszy
  2. Tekst drugi
  3. Tekst trzeci

Lista wypunktowana

- Tekst pierwszy
- Tekst drugi
- Tekst trzeci

aby uzyskać:

  • Tekst pierwszy
  • Tekst drugi
  • Tekst trzeci

Kod

Markdown pozwala na wstawienie bloku zawierającego tekst, który ma być zaprezentowany tak jak jest, czyli bez żadnych zmian. Jest to bardzo ważny blok szczególnie dla programistów, którzy chcą się podzielić kodem, tak, który będzie działać po skopiowaniu i wklejeniu. Tego typu blok został zastosowany w powyższych przykładach, gdy zaprezentowałem, jak zastosować i jaki efekt uzyskamy.

Blok kodu wstawia się za pomocą symbolu `.

Kod w tekście

Jeżeli chcemy wstawić kod w tekscie tak jak tutaj, używamy na początku i na końcu pojedynczego symbolu.

Kod w postaci bloku

W przypadku, gdy chcemy utworzyć blok, który może zawierać kilka linijek, wówczas używamy na początku i na końcu trzy takie znaki (```).

blok kodu

Linia pozioma (separator)

Aby szybko wstawić linię, która oddzieli jeden tekst od drugiego, wystarczy wstawić trzy myślniki ---

Efekt:


Odnośnik

W trakcie pisania tekstu często zdąży się, że chcemy dodać odniesienie do innej części na naszej stronie lub do czegoś zlokalizowanego w internecie. Wówczas używamy odnośnika w następującej formie [tekst odnośnika](https://www.example.com)

aby uzyskać:

tekst odnośnika

Obrazy

Aby wstawić obraz do naszego tekstu, wystarczy użyć podobnego bloku jak powyżej, tyle że poprzedzić go wykrzyknikiem ![tekst alternatywny](obraz.jpg)

Tekst alternatywny zostaje wyświetlony, jeżeli jest problem z załadowaniem naszego pliku obraz.jpg.

Obraz z Odnośnikiem

Wszelkie powyższe bloki możemy miksować ze sobą.

Jeżeli wstawimy obraz do naszego tekstu, przydałoby się dodać możliwość kliknięcia w niego, aby wyświetlić go w pełnej okazałości. W tym celu miksujemy powyższe w sposób następujący.

[![tekst alternatywny](obraz.jpg)](obraz.jpg)

Wewnętrzny obraz.jpg odpowiada za to, co wyświetli nam się na ekranie. Zewnętrzny, za to, co wyświetli nam się po kliknięciu.

I tyle, jeżeli chodzi o podstawowe elementy w Markdown.

Jak zauważysz, nie jest ich dużo i podczas pisania stają się one bardzo intuicyjne w użytku.

Elementy zaawansowane w Markdown

Tutaj sytuacja zaczyna się nieco komplikować.

W zależności od tego, gdzie będziemy używać Markdown do dyspozycji mamy elementy, które w jednego odmianie Markdown będą działać, natomiast w innej nie. Dlatego ważne jest wybranie między innymi edytora, w którym będziemy pisać, aby wspierał to, co będziemy używać, oraz skryptu do publikacji. W moim przypadku przedstawione elementy poniżej są używane w ramach Hugo do wyświetlenia ich na stronie internetowej.

Tabele

Wykorzystując poniższy Markdown otrzymamy tabelę.

| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |

w następującej formie:

SyntaxDescription
HeaderTitle
ParagraphText

Przypisy

Przypisy są bardzo przydatne dla autorów tekstu, którzy dodają odniesienia do źródeł. Dzięki przypisom w tekście, na końcu strony buduje nam się tabela, którą później uzupełniamy tym, co potrzebujemy.

Tekst w twoim zdaniu. [^1]

[^1]: Przypis do tego tekstu

Jeżeli aktywnie używasz Wikipedii, zapewne zauważyłeś, jak przypisy działają, dając ci odniesienie do artykułów źródłowych, na bazie których dany wniosek został wysnuty.

Przekreślenie

Czasami się zdarza tak, że napiszemy tekst, który później poprawimy, ale chcielibyśmy pokazać gdzie nastąpiła zmiana. Do tego celu używamy dwóch symboli ~ przed i na końcu.

Bardzo lubię lody ~~czekoladowe~~ waniliowe.

Co będzie wyglądać tak:

Bardzo lubię lody czekoladowe waniliowe.


I to by wystarczyło na owocną pracę z tekstem.

Oczywiście, apetyt rośnie w miarę jedzenia. W związku z tym możemy zacząć wykorzystywać inne dostępne elementy Markdown, ale tak naprawdę, to co przedstawione powyżej stanowić będzie 95% tego, czego będziesz używać podczas pisania.

Na koniec o Typora

O ile iA Writer ma nieco więcej ‘oh’ w swoim wyglądzie, o tyle Typora przypodobała mi się integracją z systemem operacyjnym Windows 10.

Jeżeli w naszym systemie zainstalowane mamy dwa lub więcej języki wraz z dodatkiem do sprawdzania pisowni, program ten może to wykorzystać wewnątrz swojego okna aplikacji. Bez konieczności własnego wsparcia dla sprawdzania pisowni, mamy do dyspozycji potężne narzędzie dostarczone wraz z naszym systemem operacyjnym.

Oczywiście, żadne narzędzie nie jest idealne i swoje teksty, przed publikacją po polsku, przerzucam przez ortograf.pl . W przypadku języka angielskiego pomagam sobie przy pomocy Grammarly oraz Outwrite .

Pozdrawiam.