Pro koho to je
Dokumentace do Markdownu bez úklidu
Migrace dokumentace obvykle znamená převést HTML a pak dlouho odstraňovat to, co si převodník nechal. Právě tohle odstraňování je změřená část: nula zbylých HTML značek napříč 512 stránkami a 102 zdvojených řádků navigace proti 282, 478 a 491 u tří jiných nástrojů.
Převod, po kterém se uklízí
Obecný převodník HTML do Markdownu odvede osmdesát procent práce a zbylých dvacet nechá na vás. V souboru zůstanou div, span a atributy, postranní navigace se přimíchá mezi odstavce a přepínač verzí se objeví uprostřed výkladu. U jedné stránky je to chvilka, u dvou set je to projekt.
K tomu se ztrácejí zrovna ty prvky, kvůli kterým je dokumentace dokumentací. Bloky kódu přijdou o značku jazyka, tabulky parametrů se sesypou, upozornění a rámečky zmizí nebo se změní v obyčejný odstavec, takže z výstrahy je poznámka. Kontrolovat to stránku po stránce znamená přečíst celou dokumentaci znovu.
Co se změní
- Nadpisy, seznamy, tabulky, bloky kódu i poznámky pod čarou mají standardní protějšek v Markdownu
- Značky jazyka zůstávají u bloků kódu: 73 ze 156 na technickém korpusu, proti 20 a 0
- Nula zbylých HTML značek napříč 512 změřenými stránkami
- Upozornění a rámečky se stanou citací – obsah zůstane, i když pro ně Markdown značku nemá
- Postranní navigace, drobečky a přepínače verzí se odříznou, ne převedou
- Šablona názvu souboru a podsložka udrží importovanou sadu v pořádku
## Přidání balíčku do projektu 1. Otevřete terminál ve složce projektu. 2. Spusťte příkaz `dotnet add package`. > **Poznámka** > Balíček vyžaduje .NET 8 nebo novější.
Co nedělá
Neprochází dokumentační web a neumí stáhnout celou sadu naráz – ukládáte stránku po stránce, tu, na které stojíte. Nepřevádí navigaci na obsah, takže strom stránek ani odkazy mezi nimi za vás nesestaví. Obrázky a diagramy zůstávají odkazy na původní web, soubory se vedle poznámky neukládají. Rámečky přijdou o styl: zachová se obsah, ne vzhled.