Skip to content
Snippets Groups Projects
README.md 1.09 KiB
Newer Older
Lukáš Krupčík's avatar
Lukáš Krupčík committed
Převod html dokumentace do md formátu (version 0.4) - BETA
Lukáš Krupčík's avatar
Lukáš Krupčík committed
===========================================================
Lukáš Krupčík's avatar
Lukáš Krupčík committed

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

Lukáš Krupčík's avatar
Lukáš Krupčík committed
### Základní požadavky
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
- stažení celé adresářové struktury docs.it4i.cz
- konverze html souborů na md soubory
- zachování stejného formatování jako na webu
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
### Postup
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Pro svou práci si naklonujete Gitem repozitář do svého pracovního adresáře.

Lukáš Krupčík's avatar
Lukáš Krupčík committed
>**Problémy**
Lukáš Krupčík's avatar
Lukáš Krupčík committed
> * obrázky nemají správný odkaz na uložení v adresářích (částečně vyřešeno)
> * interní a externí odkazy
> * formátování tabulek
> * formátovámí textu v některých místech
Lukáš Krupčík's avatar
Lukáš Krupčík committed
> * doba převodu ~24min
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
>**Změny v nové verzi**
Lukáš Krupčík's avatar
Lukáš Krupčík committed
> * oprava odkazu na obrázky a vylepšené filtrování
> * přehled o počtu souboru a stavu převodu
> * optimalizace, začlenění testovacích funkcí do hlavní větve programu
Lukáš Krupčík's avatar
Lukáš Krupčík committed
### Funkce skriptu

Stažení souborů:

```bash
html_md.sh -w
```

Konverze html do md

```bash
html_md.sh -c
```
Lukáš Krupčík's avatar
Lukáš Krupčík committed

Lukáš Krupčík's avatar
Lukáš Krupčík committed
Testování
Lukáš Krupčík's avatar
Lukáš Krupčík committed

```bash
html_md.sh -t
Lukáš Krupčík's avatar
Lukáš Krupčík committed
```