Használja a Markdown alkalmazást az elérhető és megbízható szoftverdokumentáció érdekében.
Mi az a Markdown?
A Markdown (vagy MD) egy ingyenes, könnyen használható jelölőnyelv, amellyel szervezettebbé és interaktívabbá tehető a programozási dokumentáció. Szinte bármilyen IDE-ben (integrált fejlesztőkörnyezetben) megvalósítható nehéz telepítések nélkül.
Miért fontos a dokumentáció?
A jó dokumentáció a megfelelő oldalon tarthatja a szoftverfejlesztő csapatot. Ez azért fontos, mert folyamatosan tájékoztatja a csapatot, csökkenti a félreértések esélyét, és a projekt minden részlete elérhető a csapat számára.
Más szóval, a dokumentáció sikert jelent a csapat számára és minőséget a projekt/termék/alkalmazás számára.
Szintaxis az MD-hez
Alapvető formázás
- Merész/erős:
**Bold** - Kiemelt/dőlt:
*Emphasized* - Áthúzás:
~~Strikethrough~~ - Vízszintes szabályok:
---(három kötőjel),***(három csillag) vagy___(három aláhúzás).
Címsorok
Minden címsorszintet (pl. H1, H2 stb.) # jelöl a sor elején. Például egy H1 értéke # Heading 1 és egy H2 értéke ## Heading 2. Ez így folytatódik: ###### Heading 6.
Linkek
A hivatkozások több módszerrel hozhatók létre:
- A linkek lehetnek
[inline](https://joshecamp.medium.com/) - A szövegközi hivatkozások
[have a title](https://joshecamp.medium.com/ "Hover text") - Ezenkívül lehetnek hivatkozási hivatkozások, amelyek lehetővé teszik az URL későbbi elhelyezését a dokumentumban:
- Itt van egy
[reference link][joshecamp], amely erre a webhelyre mutat. - A hivatkozások nem tesznek különbséget a kis- és nagybetűk között (például
[this link][joshecamp]működik). - Hivatkozások/lábjegyzetek is
[use numbers][1]. - Vagy hagyja üresen, és használja a
[link text itself]. - Használhat relatív hivatkozásokat is [így](../blob/master/LICENSE.txt).
- A szögletes zárójelben lévő URL-ek és URL-ek automatikusan linkekké alakulnak: https://joshecamp.medium.com/vagy
<https://joshecamp.medium.com/>.
Képek
A képek lehetnek beágyazottak, vagy használhatnak hivatkozási stílust, hasonlóan a hivatkozásokhoz. Egyszerűen írjon egy felkiáltójelet a hivatkozás képpé alakításához. Például:
Images with the full URL: 
A listák a listaelemek jelzésére behúzással és sor eleje jelölővel készülnek. A rendezetlen listák például így készülnek:
* One item
* Another item
* A sub-item
* A deeper item
* Back in sub-item land
* And back at the main level
A rendezetlen listák csillagot (*), pluszt (+) vagy mínuszt (-) használhatnak az egyes listaelemek jelzésére.
A rendezett listák egy számot használnak a sor elején. A számokat nem kell növelni – ez a HTML automatikusan megtörténik. Ez megkönnyíti a megrendelt listák (MD nyelven) szükség szerinti újrarendezését.
Ezenkívül rendezett és rendezetlen listák egymásba ágyazhatók. Például:
* One item
* Another item
1. A nested ordered list
1. This is the second item
* And now an unordered list as its child
* Another item in this list
1. One more in the ordered list
* And back at the main level
Kód és szintaxis kiemelés
A soron belüli kód `backticks`-t használ körülötte. A kódblokkokat vagy három backtick (```) keríti el, vagy négy szóköz van behúzva. Például:
``` var foo = 'bar';function baz(s) { return foo + ':' + s; } ```
Blokkidézetek
Használja a > t a szöveg eltolása idézőjelként. Például:
> This is some part of a blockquote.
> Some more stuff.Termelni fog:
Ez egy idézet egy része. Még néhány dolog.
A minta MD-fájl eléréséhez "kattintson ide".
PYZCES projekt: Személyes erőforrás Python programozóknak a C szintaxis és a C programozók számára a python szintaxis megértéséhez a Markdown és a HTML használatával a két nyelv egymás melletti megjelenítéséhez.
Források:
Cone, M. (2017). Markdown csalólap. Leértékelési útmutató. Letöltve 2022. január 31-én, innen: https://www.markdownguide.org/cheat-sheet/
Thomerson, J. (2017). Konvertálja a leértékelést HTML-re. Ingyenes Markdown to HTML Converter. Letöltve 2022. január 31-én, innen: https://markdowntohtml.com/
