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 +```