×
Creating solutions

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
No part of this article may be reproduced without mention of the author and URL to this website.
For more information, see the About section.

Comments

Article has no comments.

Add a comment

Name (required)
Website
Message (required)
Submit
From latest