diff --git a/README.md b/README.md index 5b4f7ed8c044b8143ef1711d474d174c68ab5e8d..87d0328a02bd4e4cf7604e1570b5b93daabc964d 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,37 @@ -### PĹ™evod html dokumentace do md formátu +# PĹ™evod html dokumentace do md formátu -* stáhne soubory (html, jpg, png, ...) -``` -html_md.sh -w -``` +## CĂl -* pĹ™evede html do md, vytvořà sloĹľku info, kde se evidujĂ odkazy na soubory ve sloĹľkách -``` -html_md.sh -c -``` +VĂ˝sledkem projektu by mÄ›l bĂ˝t skript pro staĹľenĂ a pĹ™evod stávajĂcĂ dokumentace na docs.it4i.cz do md formátu -* odstranĂ všechny html soubory -``` -html_md.sh -d -html -``` +## ZákladnĂ poĹľadavky + +* staĹľenĂ celĂ© adresářovĂ© struktury docs.it4i.cz +* konverze html souborĹŻ na md soubory +* zachovánĂ stejnĂ©ho formatovánĂ jako na webu + +## Postup -* odstranĂ všechny md soubory +Pro svou práci si naklonujete Gitem repozitář do svĂ©ho pracovnĂho adresáře. + +### Funkce skriptu + +StaĹľenĂ souborĹŻ: + +```bash +$ ./html_md.sh -w ``` -html_md.sh -d -md + +### Konverze html do md + +```bash +$ ./html_md.sh -c ``` +### SmazánĂ html/md souborĹŻ +```bash +$ ./html_md.sh -d -html +$ ./html_md.sh -d -md +```