Introduction

Toto je dokumentace k xTrace.Docs

Jak pracovat s tímto projektem

1. Naklonuj si repos xTrace.Docs z github
2. Otevři jej jako adresář ve Visual Studio Code, Notepad ++)
3. Spusti CMD
4. cd \Source\Repos\xTrace.Docs nebo tam kde jsi si naklonoval repos

build do lokálního dockeru

docker build -t moje xtrace-docs . docker run -p 8000:8000 xtrace-docs

Jak přidávat a pushovat

git add . (nebo nazebv souboru) git commit -m "Popis změn" git push

Tipy pro psaní markdown (syntax)

1. Na konci řádku dát vždy dvě mezery (to je pro Markdown až line break)
2. Za # při nadpisu dát vždy mezeru
3. Odkazy na soubory se píší s normálním / nikoliv se zpětným \
4. Kódování souboru .md musí být alespoň UTF-8 jinak to nedá češtinu
5. Pro odkázání se na složku images v root složce musíte zadat tolikrát ../ v kolika podsložkách jste než můžete konečně odkázat na images/obrazek.png a nebo jsem se nedočetl žádného kloudného řešení, které by mi fungovalo
6. NIKDY nedávejte do názvu mezery
7. NIKDY nedávejte do názvu české znaky

TODO list

1. Zkontrolovat názvy, aby byly bez diakritiky, mezer, speciálních znaků
2. Zkontrolovat nadpisy, aby byly bez podtržítek
3. Je to case sensitive, je lepší nepoužívat velká písmena