×
COOKIES
Prezeraním tejto stránky dochádza k spracovaniu cookies. Spracovaniu cookies zabránite v nastaveniach internetového prehliadača alebo nezobrazovaním tejto stránky v internetovom prehliadači.
Vytvárame riešenia

Ako na GitHube písať dokumentáciu

V tomto krátkom článku uvediem link na dokumentáciu pre písanie súboru README.md na úložisku GitHub. Začínajúci prispievatelia totiž môžu naraziť na problém, že pri vložení textu reprezentujúceho programový kód nie je časť z tohto kódu viditeľná, prípadne kód nie je viditeľný vôbec.
Návod na písanie dokumentácie sa volá Basic writing and formatting syntax. Ide o markdown jazyk, ktorý je jednoduchý a jeho dokumentácia je veľmi dobre spracovaná.

Záver

Do pozornosti dávam aj pôvodný Markdown od Johna Grubera. Vlastnú podobu markdown jazyka používam aj ja vo svojich projektoch.


Softvér,GitHub,documentation,markdown,writing,formatting,syntax
Žiadna časť tohto článku nesmie byť reprodukovaná bez uvedenia autora a URL na túto stránku.
Viac informácií nájdete v sekcii O projekte.

Komentáre

Článok neobsahuje zatiaľ žiadne komentáre.

Pridať komentár

Meno (povinné)
Web
Správa (povinné)
Odoslať
Od najnovších