Phenquestions
Standardowa przecena
Markdown to standard opracowany przez Johna Grubera. Głównym celem Markdown jest umożliwienie odczytania pliku nawet w czystym tekście. Jeśli chcesz zajrzeć do edytora tekstowego, powinieneś mieć łatwy czas na przeczytanie tego. Jest to bardzo pomocne dla użytkowników vima i podobnych. Zwróć uwagę i pamiętaj, że jest to standard zmiany plików tekstowych. Nie zastępuje HTML. Zamiast tego używasz go do tworzenia kodu HTML tam, gdzie jest przydatny. W przypadku GitHub sformatują plik Readme na stronie. Dopóki trzymasz się standardu, możesz mieć pewność, że będzie dobrze wyglądać.
Ponieważ GitHub dodał tylko kilka rozszerzeń, powinieneś zacząć od użycia ściągawki Markdown i stamtąd. Oto lista najczęstszych.
| Obniżka cen | Rozszerzenia | Wynik |
| # (1 na poziom) | Nagłówki | |
| * | Kursywa | |
| ** | Pogrubienie | |
| > | Zablokować cytat | |
| 1. (itp.) | Uporządkowana lista | |
| - | Lista nieuporządkowana | |
| 'kod' | Twój kod | |
| „” | Md-ext | Rozpocznij i zakończ blok kodu |
| - | Linia pozioma | |
| [Opis](https://www.przykład.com) | Nazwa w kwadracie i URL w zwykłych nawiasach | |
|  | To samo, link do obrazu | |
| [1] | Md-ext | Przypis |
Listy można zagnieżdżać, wcinając dowolne elementy, które chcesz zagnieździć.
Inne rozszerzenia do zwykłego Markdowna, masz powyższe rozszerzenia bloków kodu. Nie zawsze są obsługiwane przez usługi.
| Obniżka cen | Rozszerzenia | Wynik |
| ### Nagłówek #identyfikator niestandardowy | Md-ext | Nagłówek, do którego możesz zaadresować jego identyfikator |
| termin: definicja | Md-ext | Lista terminów z definicjami |
| ~Błędny tekst~ | Md-ext | Przekreślony tekst |
| - [x] Zadanie do zrobienia | Md-ext | Lista zadań, którą możesz odhaczyć |
Tabela jest bardzo prosta, ale do jej pokazania potrzeba kilku wierszy: Tabela:
| Nazwa | WARTOŚĆ|| ----------- | ---------- |
| Maty | 100 |
Rozszerzenia GitHub.
GitHub dodał kilka rozszerzeń, aby ułatwić obsługę linków do innych osób i projektów. Niektóre z nich to wspomniane wcześniej tabele. Tym, który najbardziej Ci pomoże, jest rozszerzenie z automatycznym łączeniem. Tworzy link samodzielnie, gdy używasz go na GitHub.
Inne to tabele i elementy listy zadań. Są one wygodne do śledzenia zadań w projektach. Ostatnim, o którym należy wspomnieć, jest rozszerzenie Disallowed Raw HTML. Za pomocą tego rozszerzenia niektóre tagi są filtrowane podczas renderowania dla HTML. Te tagi mogą powodować dziwne efekty podczas renderowania na GitHub.
Sposoby eksploracji GitHub Markdown
Jeśli uznasz to za mylące, możesz również przejść do strony GitHub i skorzystać z wbudowanego edytora. Kiedy go użyjesz, automatycznie uzupełni niektóre funkcje. Działa to tylko w przypadku problemów, ale możesz go użyć, aby dowiedzieć się kilku rzeczy, emotikony pojawiają się jako lista po wpisaniu dwukropka (:).
Możesz również znaleźć projekt na GitHubie, który ma świetnie wyglądający plik README i sklonować go na dysk lokalny. Stamtąd możesz przeglądać plik za pomocą dowolnego edytora. Dla dużych edytorów, Emacsa i Vima, istnieje wsparcie dla przecen poprzez rozszerzenia.
Jeśli używasz vima, możesz dodać rozszerzenie podświetlania składni z GitHub, vim-markdown. To rozszerzenie pokazuje, że poprawnie wykonałeś kod. Aby pomóc Ci zobaczyć, jak to wygląda po zakończeniu, możesz również pobrać rozszerzenie znacznika na żywo. Dzięki temu możesz uruchomić serwer WWW, pokazując wynik na żywo podczas pisania.
Z Emacsem masz tryb niecierpliwy, wyłączony na żywo i podgląd w czasie rzeczywistym. Wszystkie wyświetlają stronę wynikową w przeglądarce podczas pisania. Pierwsza wymaga mniej bibliotek niż druga, ale do uruchomienia potrzebuje dodatkowego fragmentu kodu.
Wniosek
Mimo że przecena jest małą i celowo prostą specyfikacją, na początek może być trochę myląca. Najlepszym sposobem na naukę jest użycie ściągawki i napisanie dokumentu Markdown Mark. Możesz zaktualizować swoje README.md na GitHub i możesz uzyskać duże wsparcie dzięki wbudowanym funkcjom edytorów. Na marginesie, GitHub obsługuje również emotikony, które możesz dodać do swojego dokumentu. Możesz użyć ściągawki, aby dowiedzieć się, które to są.
Pobierz Markdown-CheatSheettutaj
