Exportovat dokumentaci a changelog
Váš web s dokumentací už možná má vlastní build, nebo klient chce návod jako PDF. kaloko export zapíše dokumentaci i changelog s obrázky jako obyčejné soubory, takže nic nezůstane zamčené v Kaloku.
Vyberte formát
npx kaloko export --format docusaurus --out website/docs--format | Co dostanete | Plán |
|---|---|---|
md | Markdown se složkou assets/ s obrázky, pro jakýkoli statický web | každý plán |
json | changelog jako strukturovaný JSON | každý plán |
docusaurus | složka pro Docusaurus s front matter, kategoriemi a postranním menu | od plánu Business |
vitepress | složka pro VitePress s konfigurací | od plánu Business |
mkdocs | složka pro MkDocs s mkdocs.yml | od plánu Business |
html | HTML pro offline čtení: stránka na každý návod, changelog a stránka pro tisk | od plánu Business |
pdf | jedno PDF vytištěné prohlížečem | od plánu Business |
Z odkazů na kroky se stanou obyčejné obrázky v jazyce a velikosti obrazovky exportu.
Vyberte, co do exportu patří
--what docsnebo--what changelogvyexportuje jen jedno z nich; výchozí jsou obě.--version 2.4.0vyexportuje dokumentaci vydání místo té nejnovější.--lang csvyexportuje jeden jazyk.--product shopvybere produkt, když jich konfigurace má víc.--outurčí složku nebo soubor, kam se export zapíše.
Publikované, nebo lokální
Bez dalších voleb export vezme to, co jste publikovali přes kaloko docs publish. S --local vezme soubory ve vašem repozitáři, aniž by je publikoval. Hodí se to, když chcete změnu zkontrolovat dřív, než půjde ven.
Udržujte web s dokumentací v souladu
Existující web si nechá vlastní build. Buď do jeho složky vyexportujete a výsledek commitnete, nebo export spustíte v jeho CI před buildem:
npx kaloko export --format vitepress --what docs --out docs-site/guideToken v CI potřebuje jen čtení; viz Role a API tokeny.
Stáhněte export ze stránky dokumentace
Čtenáři, kterým vyhovuje soubor, použijí Stáhnout na stránce dokumentace nebo changelogu. Nabídne stejné formáty; v plánech pod Business jsou i tam jen Markdown a JSON.
Každý export se otevře i bez Kaloka. Odkud stránky pocházejí a jak je držet aktuální, popisuje Publikovat živou dokumentaci a hlídat zastaralé části.