Markdown Toolbox Logo Markdown Toolbox
itthon
Blog

Csalási táblázat - GitHub stílusú Markdown

2023-12-12

A GitHub Flavored Markdown (GFM) kiterjeszti a standard Markdown szintaxist, hogy néhány GitHub-ra jellemző további funkciót is magában foglaljon. Ez a gyorstájékoztató a GFM kulcsfontosságú aspektusait tartalmazza, megkönnyítve ezzel a READMEs, problémák és egyéb dokumentációk létrehozását a GitHubon.

Kibővített szintaxis

Feladatlisták

  • Hozzon létre feladatlistákat - [ ] használatával a befejezetlen feladathoz és - [x] használatával a befejezett feladathoz.

    -   [x] Befejezett feladat
    -   [ ] Befejezetlen feladat
    

Keresztülhúzás

  • Használjon dupla hullámjelet ~~ a szöveg áthúzásához.

    ~~Keresztülhúzás~~
    

Táblázatok

  • Készítsen táblázatokat kötőjelek - és csőjelek | használatával.

    | Fejléc 1 | Fejléc 2 |
    | -------- | -------- |
    | Sor 1   | Adat 1   |
    | Sor 2   | Adat 2   |
    

Kerített kódblokkok

  • Használjon hármas visszafelé apostrofot (```) és adjon meg egy nyelvet a szintaxis kiemeléséhez.

    ```javascript console.log("Hello, world!"); ```

Felhasználók és csapatok említése

  • Használjon @username a felhasználó vagy csapat említésére.

Problémák és Pull Request hivatkozások

  • Hivatkozzon a problémákra és pull requestekre # használatával.

Standard Markdown szintaxis

Fejlécek

  • Használjon # a fejléchez. Minél több # szerepel, annál kisebb a fejléc.

Szövegformázás

  • A vastag: **vastag**
  • Félkövér: *félkövér*
  • A vastag és félkövér: ***vastag & félkövér***

Listák

  • Rendezetlen lista: Kezdje -, +, vagy * használatával.
  • Rendezett lista: Kezdje számokkal, amelyek után . áll.

Linkek és képek

  • Link: [Cím](URL)
  • Kép: ![Alternatív szöveg](URL)

Idézetek

  • Használjon > a blokk idézetekhez.

A GitHub Markdown lehetővé teszi az interaktívabb és dinamikusabb dokumentációt, különösen együttműködő projektek esetében.