Phenquestions
A szokásos Markdown
A Markdown egy John Gruber által kifejlesztett szabvány. A Markdown fő célja, hogy a fájl tiszta szövegben is olvasható legyen. Ha csak szöveges szerkesztőben szeretne keresni, akkor könnyedén el kell olvasnia. Ez nagyon hasznos a VIM és hasonló felhasználók számára. Ne feledje, és ne feledje, hogy ez a szövegfájlok megváltoztatásának szabványa. Nem helyettesíti a HTML-t. Ehelyett HTML létrehozásához használja, ahol hasznos. A GitHub esetében a webhelyen formázzák a Readme fájlt. Amíg betartja a szabványt, biztos lehet benne, hogy jól fog kinézni.
Mivel a GitHub csak néhány kiterjesztést adott hozzá, el kell kezdeni egy Markdown-cheatsheet használatával, és onnan kell menni. Itt található a leggyakoribbak listája.
| Árleszállítás | Hosszabbítások | Eredmény |
| # (Szintenként 1) | Címsorok | |
| * | Dőlt betű | |
| ** | Bátor | |
| > | Blokkolás | |
| 1. (stb.) | Rendezett lista | |
| - | Rendezetlen lista | |
| 'kód' | A kódod | |
| "" | Md-ext | Indítsa el és fejezze be a kódblokkot |
| - | Vízszintes szabály | |
| [Leírás] (https: // www.példa.com) | Név négyzetben és URL zárójelben | |
| ![alt szöveg] (kép.png) | Ugyanaz, link egy képhez | |
| [1] | Md-ext | Lábjegyzet |
A listák egymásba ágyazhatók, ha behúznak minden beágyazni kívánt elemet.
A szokásos Markdown egyéb kiterjesztései, a fenti kódblokk-bővítmények vannak. A szolgáltatások nem mindig támogatják őket.
| Árleszállítás | Hosszabbítások | Eredmény |
| ### Fejléc # custom-id | Md-ext | Olyan címsor, amelyet az azonosítója alapján címezhet meg |
| kifejezés: meghatározás | Md-ext | Kifejezések listája definíciókkal |
| ~ Hibás szöveg ~ | Md-ext | Áthúzott szöveg |
| - [x] Feladat | Md-ext | Feladatlista, amelyet kipipálhat |
A táblázat nagyon egyszerű, de több sorra van szüksége a megjelenítéséhez:
| Név | ÉRTÉK || ----------- | ---------- |
| Szőnyegek 100 |
GitHub kiterjesztések.
A GitHub hozzáadott néhány kiterjesztést, hogy egyszerűbb legyen kezelni a más emberekhez és projektekhez vezető linkeket. Ezek egy része a korábban említett táblázatok. A legjobban az automatikus link kiterjesztése segít. Önálló linket hoz létre, amikor a GitHubon használja.
Mások táblák és Feladatlista elemek. Ezek kényelmesen nyomon követhetik a feladatait a projektekben. Utoljára a Disallowed Raw HTML kiterjesztést kell megemlíteni. Ennek a kiterjesztésnek a segítségével egyes címkék kiszűrésre kerülnek a HTML-höz történő rendereléskor. Ezek a címkék furcsa hatásokat okozhatnak a GitHub-ba történő megjelenítéskor.
A GitHub Markdown felfedezésének módjai
Ha zavarónak találja, akkor a GitHub oldalra is beléphet, és használhatja a beépített szerkesztőt. Használatakor automatikusan elvégzi egyes funkciókat. Ez csak problémák esetén működik, de néhány dolog kitalálásához használhatja, az emojis listaként jelenik meg, amikor kettőspontot ír be (:).
Megtalálhat egy olyan projektet is a GitHubon, amely nagyszerű README fájlt tartalmaz, és klónozza a helyi meghajtóra. Innen bármely kívánt szerkesztő segítségével felfedezheti a fájlt. A nagy szerkesztők, az Emacs és a Vim számára támogatást nyújt a kiterjesztésekkel történő jelölés.
Ha vim-et használ, beilleszthet egy szintaxis kiemelő kiterjesztést a GitHubból, vim-markdown. Ez a kiterjesztés megmutatja, hogy helyesen tette-e meg a kódot. Az éles jel kiterjesztését megkaphatja, ha készen áll a megjelenésére. Ezzel futhat egy webkiszolgáló, amely gépelés közben élőben mutatja az eredményt.
Az Emacs használatával türelmetlen módban, élő állapotban és valós idejű előnézettel rendelkezik. Mindegyik megjeleníti az eredményül kapott oldalt egy böngészőben, miközben gépel. Az elsőhöz kevesebb könyvtárra van szükség, mint az utóbbihoz, de futtatásához extra kódrészletre van szükség.
Következtetés
Annak ellenére, hogy a markdown kicsi és szándékosan egyszerű specifikáció, kissé zavaró lehet a kezdés. A tanulás legjobb módja, ha egy csalólapot használ, és megírja a Markdown dokumentumot. Frissítheti a README-t.md a GitHubon, és sok támogatást kaphat szerkesztőinek beépített funkcióiból. Megjegyzendő, hogy a GitHub támogatja a hangulatjeleket is, amelyeket hozzáadhat a dokumentumához. A csalólap segítségével megtudhatja, melyek azok.
Töltse le a Markdown-CheatSheet Here alkalmazást
