Export docs and the changelog
Your docs site may already have its own build, or a client wants the guide as a PDF. kaloko export writes the docs and the changelog with their pictures as plain files, so nothing stays locked in Kaloko.
Pick a format
npx kaloko export --format docusaurus --out website/docs--format | What you get | Plan |
|---|---|---|
md | Markdown with an assets/ folder of pictures, for any static site | every plan |
json | the changelog as structured JSON | every plan |
docusaurus | a Docusaurus folder with front matter, categories and sidebars | Business and up |
vitepress | a VitePress folder with its config | Business and up |
mkdocs | a MkDocs folder with mkdocs.yml | Business and up |
html | offline HTML: a page per guide, the changelog and a print page | Business and up |
pdf | one PDF, printed by the browser | Business and up |
The step references become ordinary image files, in the language and screen size of the export.
Choose what goes in
--what docsor--what changelogexports only one of them; the default is both.--version 2.4.0exports the docs of a release instead of the latest.--lang csexports one language.--product shoppicks a product when the config has several.--outnames the folder or file to write.
Published or local
By default the export takes what was published with kaloko docs publish. --local takes the files in your repository instead, without publishing them, which is handy for checking a change before it goes out.
Keep a docs site in step
An existing site keeps its own build. Either export into its folder and commit the result, or run the export in the site's CI before it builds:
npx kaloko export --format vitepress --what docs --out docs-site/guideThe token in CI needs only read access; see Roles and API tokens.
Download from the docs page
Readers who prefer a file can use Download on the docs or changelog page. It offers the same formats; on plans below Business only Markdown and JSON are available there too.
Every export opens without Kaloko. For the source of the pages and how to keep them current, see Publish living docs and catch stale sections.