kconv
Convert the content of any supported format into another. kconv reads a
document into kapi's content model and re-expresses it in a different format,
carrying the structure across — headings, lists, tables and inline
formatting — rather than the source bytes.
kconv [flags] [FILE...]
The target format comes from --to — a format id such as markdown, html or
doclang, or an extension such as md — or is inferred from the -o output
extension. With no -o, the result is written to standard output. With no file,
or when the file is -, standard input is read.
How the conversion works
kconv is a projection of the content model. Each block carries a normalized
role — heading, list item, table cell, caption — and kconv renders that
role in the target format: a heading becomes #/## in Markdown or
<h1>/<h2> in HTML; a list becomes bullets or a <ul>; a table reconstructs
as an HTML <table> (Markdown lists the cells). Inline formatting is rendered
from each run's type, so a bold span becomes **…** or <strong>…</strong>
whatever spelling the source format used.
By default kconv projects the source text. --target LOCALE projects an
existing translation instead — useful for emitting a translated document in a
new format.
Supported output formats
You can read (convert from) any supported format. You can write (convert to) the document and data formats that are produced from content alone:
- Documents — Markdown, HTML, DocLang, AsciiDoc, plain text
- Data & catalogs — JSON, YAML, and the resource-string formats
Run kapi formats list for the full set, or try the
Conversion Lab to convert in your browser.
Not conversion targets:
- Bilingual interchange — XLIFF, PO, TMX, KBF — use
kapi extractinstead. Extract captures the source skeleton sokapi mergecan round-trip translations back into the original file; a converted interchange file has no skeleton and cannot be merged back. - Packaged formats — Word (
.docx), ODT, InDesign, EPUB — and read-only formats such as PDF can be converted from, but not to (they are written by updating an existing file of that format).
Examples
# A Word proposal as clean Markdown (to stdout)
kconv proposal.docx --to md
# A DocLang document to an HTML file (format from the extension)
kconv report.dclg.xml -o report.html
# A Docling-parsed scan (DoclingDocument JSON) as HTML
kconv scan.docling.json --to html
# Any supported format to DocLang
kconv guide.md -o guide.dclg.xml
# Emit the French translation of an XLIFF as Markdown
kconv messages.xliff --to md --target fr
Options
| Flag | Meaning |
|---|---|
-t, --to FORMAT | Target format — a format id (markdown, html, doclang) or an extension (md). |
-o, --output PATH | Write to PATH (format inferred from its extension); default is standard output. |
--target LOCALE | Convert the translation for LOCALE instead of the source. |
-f, --format | Override input format detection (e.g. -f docling). |
--source-lang | Source language (default en). |
--encoding | Input/output encoding (default UTF-8). |
-o takes a single input file — convert files one at a time, or omit -o to
stream to standard output.
Faithful vs. clean
Converting to the same format is a faithful round-trip — everything,
including styling and non-translatable content, is preserved (see ksed
for the same fidelity). Converting to a different format is deliberately a
clean projection: a .docx → .md keeps the document's structure and prose
but not its Word-specific packaging. Inline formatting is rendered from each
run's vocabulary type, the same model the rest of the toolbox uses (see
Inline Formatting).