Github Markdown Cheatsheet
Standardowy markdown
Markdown to standard opracowany przez Johna Grubera. Głównym celem Markdown jest umożliwienie pliku do odczytania nawet w czystym tekście. Jeśli chcesz spojrzeć na edytor tekstowy, powinieneś łatwo go przeczytać. Jest to bardzo pomocne dla użytkowników VIM i podobnych. Uwaga i pamiętaj, że jest to standard zmiany plików tekstowych. Nie zastępuje HTML. Zamiast tego używasz go do tworzenia HTML tam, gdzie jest przydatny. W przypadku GitHub sformatują plik ReadMe na stronie. Tak długo, jak postępujesz zgodnie ze standardem, możesz poczuć się, że będzie dobrze wyglądać.
Ponieważ GitHub dodał tylko kilka rozszerzeń, powinieneś zacząć od użycia ściągawki Markdown i odejść stamtąd. Oto lista najczęstszych.
| Obniżka cen | Rozszerzenia | Wynik |
| # (1 na poziom) | Nagłówki | |
| * | Kursywa | |
| ** | Pogrubiony | |
| > | Zablokować cytat | |
| 1. (itp.) | Uporządkowana lista | |
| - | Lista nieopisana | |
| 'kod' | Twój kod | |
| „” | MD-EXT | Rozpocznij i zakończ blok kodu |
| - | Linia pozioma | |
| [Opis] (https: // www.przykład.com) | Nazwa w kwadracie i adresie URL w regularnych nawiasach | |
| ![Tekst Alt] (obraz.PNG) | To samo, link do obrazu | |
| [1] | MD-EXT | Przypis |
Listy mogą zostać zagnieżdżone przez wcięcie wszelkich elementów, które chcesz zagnieżdżać.
Inne rozszerzenia regularnego znacznika, masz powyższe rozszerzenia bloków kodu. Nie zawsze są obsługiwane przez usługi.
| Obniżka cen | Rozszerzenia | Wynik |
| ### nagłówek #custom-id | MD-EXT | Nagłówek, do którego możesz zająć się jego identyfikatorem |
| Termin: Definicja | MD-EXT | Lista terminów z definicjami |
| ~ Mylony tekst ~ | MD-EXT | StrikeThrough Text |
| - [x] zadanie do wykonania | MD-EXT | Lista zadań, którą możesz zaznaczyć |
Stół jest bardzo prosty, ale potrzebujesz kilku rzędów, aby go pokazać: Tabela:
|. Nazwa | Wartość ||. ----------- | ---------- |
|. Mats | 100 |
Rozszerzenia github.
Github dodał kilka rozszerzeń, aby uprościć do obsługi linków do innych osób i projektów. Niektóre z nich są wymienionymi wcześniej tabelami. Ten, który najbardziej Ci pomoże, jest rozszerzenie automatycznego linku. Tworzy link sam, gdy używasz go na GitHub.
Inne to tabele i listy zadań. Są one wygodne do śledzenia zadań w projektach. Ostatnim, o którym wspomniano, jest niedozwolone rozszerzenie RAW HTML. Za pomocą tego rozszerzenia niektóre znaczniki są filtrowane podczas renderowania dla HTML. Te tagi mogą powodować dziwne efekty, gdy renderowanie github.
Sposoby odkrycia Github Markdown
Jeśli uważasz to za mylące, możesz również przejść do strony GitHub i użyć wbudowanego edytora. Gdy go użyjesz, automatycznie uzupełni niektóre funkcje. Działa to tylko w przypadku problemów, ale możesz go użyć, aby wymyślić niektóre rzeczy, emoji wychodzi jako lista, gdy wpisujesz dwukropek (:).
Możesz także znaleźć projekt na GitHub, który ma świetnie wyglądające plik Readme i sklonuj go do lokalnego dysku. Stamtąd możesz zbadać plik za pomocą dowolnego edytora, który chcesz. Dla dużych redaktorów, Emacsa i Vima, istnieje wsparcie dla Markdown poprzez rozszerzenia.
Jeśli używasz VIM, możesz umieścić rozszerzenie podświetlania składni z GitHub, Vim-Markdown. To rozszerzenie pokazuje, że wykonałeś kod poprawnie. Aby pomóc Ci zobaczyć, jak to wygląda, możesz również uzyskać rozszerzenie na żywo. Dzięki temu możesz uruchomić serwer WWW, pokazując wynik na żywo w miarę pisania.
Z EMACS masz niecierpliwy tryb, na żywo w trybie w dół i przeglądanie czasu rzeczywistego. Wszystkie pokazują twoją stronę w przeglądarce podczas pisania. Pierwszy wymaga mniej bibliotek niż te ostatnie, ale potrzebuje dodatkowego kodu, aby uruchomić.
Wniosek
Mimo że Markdown jest małą i celowo prostą specyfikacją, zacząć od. Najlepszym sposobem nauki jest użycie ściągawki i napisanie dokumentu Markdown. Możesz zaktualizować swój Readme.MD na GitHub, a możesz uzyskać dużo wsparcia z wbudowanych funkcji redaktorów. Na marginesie, GitHub obsługuje również emoji, które można dodać do dokumentu. Możesz użyć ściągawki, aby znaleźć, które są.
Pobierz Markdown-Cheatsheethere