Podstawy pisania wiadomości - Markdown


  • Admin

    Witajcie!
    Omówimy sobie dzisiaj kilka rzeczy związanych z podstawami pisania wiadomości. Zdajemy sobie sprawę, że nie każdy jest alfą i omegą i pewne kwestie na tym forum mogą sprawiać problemy zarówno tym młodszym jak i starszym jego użytkownikom.

    Przede wszystkim warto sobie zdawać sprawę, że nasze forum korzysta z składni Markdown oznacza to, że pisząc odpowiednio spreparowany tekst możemy wstawiać w nim tabele, listy podkreślenia i inne elementy formatowania. Jest to ogólnodostępny standard jednak niezbyt często stosowany na forach, stąd może się on wydawać trochę dziwny dla początkujących. Wydaje mi się jednak, że zdążyliście zauważyć, że nasze forum nie należy do grona tych zwykłych.

    Podstawowe informacje

    Idąc w myśl "Każdy ko­niec ma swój początek" tak jak ktoś kiedyś ładnie powiedział tak samo i w przypadku Markdown wszystko co się zaczyna musi się też kończyć (no może nie wszystko, jednak spora część).
    Składnia ta pozwala skupić się wyłącznie na tekście oferując przy tym wystarczające minimum do tego aby treść się dobrze prezentowała.

    Stosuje się ją np. na Github'ie pisząc dokumentacje projektów czy opisując działanie kodu, jest prosta, przejrzysta i łatwa.
    Naprawdę wystarczy obcować z nią parę minut aby poznać większość istotnych reguł, ponieważ jest ona stosunkowo naturalna i w pracy z tekstem jest na tyle intuicyjna, że przychodzi niezwykle szybko. Kilka przykładów zastosowania:

    Linki:

    Aby utworzyć link do wybranej strony wystarczy zapisać:
    [Przykładowy tekst](http://example.com) -> Przykładowy tekst

    Nagłówki:

    Kolejna istotna kwestia czyli nagłówki, w MD możemy je uzyskać przy pomocy znaku #, w zależności od wielkości nagłówka można ich zastosować maksymalnie 6 przy czym im większy indeks tym mniejsze litery.
    #### Przykładowy tekst #### (odpowiada nagłówkowi html <h4>, efekt taki jak co akapit)

    Cytowanie:

    Najbardziej intuicyjna opcja, wystarczy wstawić pojedynczy znak > Przykładowy tekst.

    Przykładowy tekst

    Ponadto mamy możliwość tworzenia list czy tabel, część z tych rzeczy jest dostępne również w formie gotowych przycisków w podczas komponowania nowej wiadomości, jednak nie wszystko możemy uzyskać w ten sposób.
    Całą podstawową składnie możecie znaleźć w tym dokumencie.

    Dodatki

    Poza standardowymi znacznikami udostępniamy kilka dodatkowych które są rozszerzeniem tej składni. Są to dokładnie trzy takie wstawki które myślę warto znać pozwalające kolejno na:

    Centrowanie:

    Domyślnie w Markdown nie występuje coś takiego ponieważ nie jest to potrzebne. My jednak umożliwiamy przy pomocy dodatkowego zestawu znaków wyśrodkować wyświetlany tekst: >-> Przykładowy tekst <-

    Przykładowy tekst

    Kolory: (rainbow)

    Następną bardzo fajną rzeczą są kolory, które możemy uzyskać poprzez: - = Przykładowy tekst = -
    Koniecznie usuwając spacje pomiędzy myślnikiem a znakiem równa się!

    Przykładowy tekst

    Spoiler:

    Czasami zachodzi potrzeba dodatkowego wyjaśnienia jakiegoś zagadnienia które niekoniecznie jest istotne dla większości ale zdarza się, że niektórzy mogą po prostu tego nie zrozumieć - spoilery to idealne rozwiązanie na ten problem. Uzyskamy je w następujący sposób: : : : Przykładowy tekst : : :. Tak jak wyżej usuwając spacje pomiędzy dwukropkiem!

    Uwaga! W przeciwieństwie do reszty spoilery renderują się dopiero po utworzeniu wątku i nie będą widoczne w generowanym na bieżąco podglądzie po prawej stronie podczas tworzenia wiadomości!

    Ok, tak się całość prezentuje sądzę, że jest to całkiem klarowne i nie będzie większych problemów z zastosowaniem.
    Zwracam tylko uwagę, że czasami trzeba dodać dodatkowo spacje lub przejście do nowej linii aby dany kod zadziałał.
    W razie problemów zapraszam do sekcji komentarzy poniżej, postaram się pomóc.