Samouczek Markdown - od konfiguracji do składni
Jednocześnie Markdown jest bardzo lekki i elastyczny. Najpopularniejszym przypadkiem użycia Markdown jest pliki licencyjne i readme w repozytorium GitHub, ale jest on również zintegrowany z coraz większą liczbą CMS do zarządzania postami na blogu, a nawet pisania dokumentów badawczych. Możesz renderować równania matematyczne z wtyczkami dla lateksu.
Jest jednak używany głównie przez programistów. Jest to bardzo pomocne w tworzeniu samouczków i dokumentacji dzięki podświetleniu składni dla wielu języków i obsłudze obrazów, a nawet gifów.
Zacznijmy od konfiguracji, która pozwala nam podgląd renderowany dokument obok surowego pliku tekstowego.
Edytor tekstu ATOM i podgląd Markdown
Możesz pobrać i zainstalować edytor tekstu ATOM lub kod Visual Studio, aby śledzić. Zarówno Atom, jak i VS Code mają wstępnie zainstalowane wtyczki do podglądu Markdown. Tutaj Atom będzie używany, ale składnia pozostanie mniej więcej taka sama bez względu na to, z jakim edytorem tekstu używasz.
W Atom upewnij się, że pakiet podglądu Markdown jest włączony (w rzeczywistości jest domyślnie włączony). Utwórz folder dla tego samouczka Markdown i tam otwórz nowy plik (Ctrl + N) i wprowadź tam następujący tekst.
# To jest nagłówek___
## To także nagłówek
Oto trochę tekstu
Zapisz plik (crtl + s) za pomocą .Rozszerzenie MD. Na przykład możesz nazwać swój plik jako test.MD i .Część MD poinformuje Atom, że jest to plik Markdown, a rozszerzenie działałoby z nim zgodnie z przeznaczeniem. Możesz wygenerować podgląd, używając następującego kluczowania (Ctrl+Shift+M), który jest pokazany w nowym panelu obok pliku surowego.
Możesz zamknąć okienko podglądu za pomocą tego samego wiązania kluczy lub za pomocą samego GUI.
Z wszystko, co skonfigurowane, możemy przyjrzeć się bliżej składni i zacząć tworzyć niesamowite dokumenty w locie.
Składnia Markdown
Jak wspomniano wcześniej, główną motywacją znacznika jest czytelność. Oznacza to brak niejasnych tagów, zagnieżdżonych tagów lub innych strun wywołujących zamieszanie. Zamiast tego możemy zacząć od symbolu „#”, aby wskazać, że ta konkretna linia to nagłówek.
# To nagłówek.## również wskazuje na kierunek, ale o mniejszym rozmiarze czcionki.
### Możesz przejść do kolejno mniejszych rozmiarów
Podziały wierszy
Markdown nadal łączy cały tekst w jeden gigantyczny akapit, nawet gdy surowy tekst jest podzielony na kilka różnych linii. Aby to złagodzić, możesz użyć dwóch przestrzeni na końcu linii, a następnie umieścić nową postać (to znaczy trafić ) lub po prostu użyj dwóch nowych znaków, aby uzyskać nieco inny efekt, jak pokazano poniżej.
Zdanie „Dlatego…” zaczęło się w nowej linii, ale nie jest odmienione oprócz poprzedniej linii, podczas gdy za pomocą dwóch nowych linii stworzyło szerszą separację.
Linia pozioma
Zasada pozioma, jak sama nazwa wskazuje, tworzy linię poziomą, która pozwala ustrukturyzować dokument i tworzyć logiczne separacje. Istnieją dwie metody tworzenia reguły poziomej. Pierwszym z nich jest użycie trzech lub więcej podkreśleń do utworzenia zasady poziomej.
#Nagłówek 1___
Akapit i nagłówek są oddzielone zasadą poziomą.
___
Kolejna oddzielona sekcja
Inną opcją (której nie polecam) jest użycie trzech lub więcej dystansów ”-„ ale są one również używane do wskazania, że zdanie bezpośrednio nad nimi jest nagłówkiem. Więc jeśli nie masz nowej linii między zdaniem a zasadą poziomą poniżej, to zdanie przyjmie formę nagłówka.
Kursywa, odważne i strajkowe
Składnia trzech z nich jest raczej prosta i mówi sama za siebie.
** To jest odważne **__ to jest również odważne
_ To jest kursywa_
*To także kursywa*
~~ to jest strikethrough ~~
Postać ucieczki
Teraz można zapytać, jak dosłownie napisałbyś ** trochę tekstu ** w końcowym pliku Markdown, jeśli po prostu zmienia to za każdym razem odważne. Jest to coś, z czym ma również do czynienia większość języków programowania, a rozwiązanie jest podobne do tych - użyj postaci odwrotnej. Działa to również w przypadku innych elementów składniowych i nie jest specjalnie dla odważnej stylizacji.
\ ** To nie jest już odważne \ **Jeśli chcesz pokazać samą postać odwrotną, użyj dwóch z nich i tak dalej.
\\ pojawia się jako pojedynczy cięcie
Blokady i bloki kodu
Blokady i bloki kodów są znacznie łatwiejsze. Można użyć blokada do podkreślenia ważnego punktu, do którego chcesz zwrócić uwagę czytelników. Można to osiągnąć, używając prawego wspornika kątowego na początku, jak pokazano.
# Nagłówek 1LoreM ipsum dolor sit amet, konsektowo -adipiscing elit, sed do eiusmod tempor incididunt ut
Labore et Dolore Magna Aliqua. Ut enim ad minima veniam, quis nostrud ćwiczenia Ullamco Laboris
Nisi ut aliquip ex ea commodo consacat. DUIS AUTE IRURE DOLOR W REPRECHENDERIT IN CILUPTATE
Velit Esse Cillum Dolore Eu fugiat nulla pariatur. Oprócz Sint Occaecat cupidatat non
Proident, Sunt in Culpa qui Officia Deserunt Mollilit Anim Id est laborum.
> To schludne podsumowanie podsekcji twojego dokumentu. > Kilka linii, które stoją
od reszty treści.
Treść trwa.
Oto jak to wygląda, gdy jest renderowany.
W przypadku bloków kodu po prostu wciśnij linie linie o 4 lub więcej przestrzeni. To jest naprawdę
Przydatny dla programistów i operatorów, którzy chcą udokumentować swoją pracę. Później zobaczymy, jak to uczynić.
Hiperłącza i obrazy
W przypadku hiperłączy składnia jest dość prosta. Widoczny tekst jest zapisywany w nawiasach kwadratowych, a adres URL, na który wskazuje, jest zapisywany w okrągłych nawiasach tuż obok niego.
W przypadku obrazów składnia jest podobna, z tym wyjątkiem, że zaczyna się od wykrzyknika. Możesz używać względnej ścieżki w folderze projektu, który wskazuje na obraz lub możesz mieć publiczny adres URL.
## ilustrowanie składni hiperłącza i obrazu___
Powinieneś [odwiedzić nas] (https: // linuxhint.com) częściej
W ten sposób obrazy są osadzone.
![SMUGPUG] (https: // prześlij.Wikimedia.org/wikipedia/commons/d/d2/bonny_bonita.JPG)
Tabele
Tworzenie tabel w Markdown obejmuje dosłownie rysowanie ASCII (Unicode, aby precyzyjnie) portret stołu.
Tabele ##|. Kolumna 1 | Kolumna 2 | Kolumna 3 |
|. ---------- | ---------- | ---------- |
|. Pierwszy rząd | Pierwszy rząd | Pierwszy rząd |
|. Drugi rząd | Drugi rząd | Drugi rząd |
Składnia nie musi być dokładnie wyrównana z jednego rzędu do drugiego, ale znak rury służy do przełączania do następnej kolumny, a następny wiersz wskazuje, że następny wiersz się rozpoczął, ogólnie.
Rozszerzone markdown
Dla tych z was, którzy zaszli tak daleko, oto prawdziwa uczta. Jeśli używasz Atom, możesz faktycznie wymienić wtyczkę podglądu Markdown dla Markdown Proview Plus. Który oferuje następujące funkcje.
1. Równania matematyczne za pomocą lateksu:
Możesz faktycznie wstawić skrypty lateksowe między znakami dolara i zostanie on renderowany jako skrypt lateksowy i pokazany w podglądu z CTRL+SHITFT+X. Nie musisz nawet znać wszystkiego LaTex, wystarczy kilka fragmentów.
## ilustrowanie lateksu___
$$ | \ psi \ rangle = \ alpha | 0 \ rangle + \ beta | \ rangle $$
2. Podświetlanie składni
Zamiast używać wgłębienia do wskazania bloków kodu, możesz faktycznie użyć backticks, a następnie nazwy języków, w których scenariusz jest podobno napisany. Języki, których składnia jest obsługiwana, są zbyt liczne, aby je tutaj wymienić, ale oto przykład w Python.
## ilustrowanie podświetlenia składni___
"pyton
importować to
def my_function ():
Drukuj („Cześć, świat!")
powrót 0
"
Istnieje wiele smaków lub znaczników. Github ma własny specjalny napar, a składnia jest bardzo elastyczna. Nie powinno to zastraszyć użytkowników, ale zaspokoić szerszą różnorodność. Jest to jeden z tych języków, które po prostu rozumieją podzbiór, którego potrzebuje i używa go, zamiast przeszkadzać w technice (chyba że jesteś zainteresowany jego technikami!)