Šķîþ ţö ḿàîñ çöñţéñţ

ķçöñṽ

Çöñṽéŕţ ţĥé çöñţéñţ öƒ àñý šüþþöŕţéđ ƒöŕḿàţ îñţö àñöţĥéŕ. kconv ŕéàđš à đöçüḿéñţ îñţö ķàþî'š çöñţéñţ ḿöđéļ àñđ ŕé-éẋþŕéššéš îţ îñ à đéŕéñţ ƒöŕḿàţ, àñđ çàŕŕîéš ţĥé šţŕüçţüŕé àçŕöšš: ĥéàđîñĝš, ļîšţš, ţàƃļéš àñđ îñļîñé ƒöŕḿàţţîñĝ.

kconv [flags] [FILE...]

Ţĥé ţàŕĝéţ ƒöŕḿàţ çöḿéš ƒŕöḿ --to (à ƒöŕḿàţ îđ šüçĥ àš markdown, html öŕ doclang, öŕ àñ éẋţéñšîöñ šüçĥ àš md), öŕ îš îñƒéŕŕéđ ƒŕöḿ ţĥé -o öüţþüţ éẋţéñšîöñ. Ŵîţĥ ñö -o, ţĥé ŕéšüļţ îš ŵŕîţţéñ ţö šţàñđàŕđ öüţþüţ. Ŵîţĥ ñö ƒîļé, öŕ ŵĥéñ ţĥé ƒîļé îš -, šţàñđàŕđ îñþüţ îš ŕéàđ.

À çöñṽéŕšîöñ ţĥàţ þŕöđüçéš à ƃîñàŕý đöçüḿéñţ (à šàḿé-ƒöŕḿàţ .docx ŕöüñđ-ţŕîþ, šàý) îš ñéṽéŕ ŵŕîţţéñ ţö à ţéŕḿîñàļ. Þàšš -o FILE, ŕéđîŕéçţ šţđöüţ, öŕ ñàḿé šţàñđàŕđ öüţþüţ éẋþļîçîţļý ŵîţĥ -o - ţö àšķ ƒöŕ ţĥé ƃýţéš àñýŵàý. Ŕéđîŕéçţéđ àñđ þîþéđ öüţþüţ îš ñéṽéŕ îñšþéçţéđ.

Šéṽéŕàļ ƒîļéš çöñṽéŕţ îñ öñé ŕüñ. Ĝîṽé -o à đîŕéçţöŕý (à ţŕàîļîñĝ šļàšĥ, öŕ à þàţĥ ţĥàţ àļŕéàđý îš öñé) àñđ éàçĥ îñþüţ îš ŵŕîţţéñ ţö îţš öŵñ ƒîļé ţĥéŕé, ñàḿéđ àƒţéŕ ţĥé îñþüţ àñđ ŕé-éẋţéñšîöñéđ ƒöŕ ţĥé ţàŕĝéţ ƒöŕḿàţ. Ŵîţĥ -r, đîŕéçţöŕý àŕĝüḿéñţš àŕé ŵàļķéđ àñđ ţĥé šüƃ-ţŕéé îš ḿîŕŕöŕéđ üñđéŕ ţĥé öüţþüţ đîŕéçţöŕý.

Ĥöŵ ţĥé çöñṽéŕšîöñ ŵöŕķš​

kconv îš à þŕöĵéçţîöñ öƒ ţĥé çöñţéñţ ḿöđéļ:

source filechanreadersource formatchanblockstext + rolechanwritertarget formatchanoutput file

Éàçĥ ƃļöçķ çàŕŕîéš à ñöŕḿàļîžéđ ŕöļé (ĥéàđîñĝ, ļîšţ îţéḿ, ţàƃļé çéļļ, çàþţîöñ) àñđ kconv ŕéñđéŕš ţĥàţ ŕöļé îñ ţĥé ţàŕĝéţ ƒöŕḿàţ: à ĥéàđîñĝ ƃéçöḿéš #/## îñ Ḿàŕķđöŵñ öŕ <h1>/<h2> îñ ĤŢḾĻ; à ļîšţ ƃéçöḿéš ƃüļļéţš öŕ à <ul>; à ţàƃļé ŕéçöñšţŕüçţš àš àñ ĤŢḾĻ <table> (Ḿàŕķđöŵñ ļîšţš ţĥé çéļļš). Îñļîñé ƒöŕḿàţţîñĝ îš ŕéñđéŕéđ ƒŕöḿ éàçĥ ŕüñ'š ţýþé, šö à ƃöļđ šþàñ ƃéçöḿéš **…** öŕ <strong>…</strong> ŵĥàţéṽéŕ šþéļļîñĝ ţĥé šöüŕçé ƒöŕḿàţ üšéđ.

Ƃý đéƒàüļţ kconv þŕöĵéçţš ţĥé šöüŕçé ţéẋţ. --target LOCALE þŕöĵéçţš àñ éẋîšţîñĝ ţŕàñšļàţîöñ îñšţéàđ, üšéƒüļ ƒöŕ éḿîţţîñĝ à ţŕàñšļàţéđ đöçüḿéñţ îñ à ñéŵ ƒöŕḿàţ.

Šüþþöŕţéđ öüţþüţ ƒöŕḿàţš​

Ýöü çàñ ŕéàđ (çöñṽéŕţ ƒŕöḿ) àñý šüþþöŕţéđ ƒöŕḿàţ. Ýöü çàñ ŵŕîţé (çöñṽéŕţ ţö) ţĥé đöçüḿéñţ àñđ đàţà ƒöŕḿàţš ţĥàţ àŕé þŕöđüçéđ ƒŕöḿ çöñţéñţ àļöñé:

  • Đöçüḿéñţš: Ḿàŕķđöŵñ, ĤŢḾĻ, ĐöçĻàñĝ, ÀšçîîĐöç, þļàîñ ţéẋţ
  • Đàţà àñđ çàţàļöĝš: ĴŠÖÑ, ÝÀḾĻ, àñđ ţĥé ŕéšöüŕçé-šţŕîñĝ ƒöŕḿàţš

Ŕüñ kapi formats ƒöŕ ţĥé ƒüļļ šéţ, öŕ ţŕý ţĥé Çöñṽéŕšîöñ ļàƃ ţö çöñṽéŕţ îñ ýöüŕ ƃŕöŵšéŕ.

Ñöţ çöñṽéŕšîöñ ţàŕĝéţš:

  • Ƃîļîñĝüàļ îñţéŕçĥàñĝé (ẊĻÎƑƑ, ÞÖ, ŢḾẊ, ĶƂƑ): üšé kapi extract îñšţéàđ. Éẋţŕàçţ çàþţüŕéš ţĥé šöüŕçé šķéļéţöñ šö kapi merge çàñ ŕöüñđ-ţŕîþ ţŕàñšļàţîöñš ƃàçķ îñţö ţĥé öŕîĝîñàļ ƒîļé; à çöñṽéŕţéđ îñţéŕçĥàñĝé ƒîļé ĥàš ñö šķéļéţöñ àñđ çàññöţ ƃé ḿéŕĝéđ ƃàçķ.
  • Þàçķàĝéđ ƒöŕḿàţš (Ŵöŕđ (.docx), ÖĐŢ, ÎñĐéšîĝñ, ÉÞÜƂ) àñđ ŕéàđ-öñļý ƒöŕḿàţš šüçĥ àš ÞĐƑ çàñ ƃé çöñṽéŕţéđ ƒŕöḿ, ƃüţ ñöţ ţö (ţĥéý àŕé ŵŕîţţéñ ƃý üþđàţîñĝ àñ éẋîšţîñĝ ƒîļé öƒ ţĥàţ ƒöŕḿàţ).

Éẋàḿþļéš​

# 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

# Everything in a folder to Markdown, one file each, in converted/
kconv ~/Downloads/* --to md -o converted/

# A whole documentation tree to HTML, sub-directories mirrored
kconv -r docs --to html -o site/

Öþţîöñš​

ƑļàĝḾéàñîñĝ
-t, --to FORMATŢàŕĝéţ ƒöŕḿàţ: à ƒöŕḿàţ îđ (markdown, html, doclang) öŕ àñ éẋţéñšîöñ (md).
-o, --output PATHŴŕîţé ţö PATH; à đîŕéçţöŕý (-o out/) ŵŕîţéš öñé ƒîļé þéŕ îñþüţ; - ñàḿéš šţàñđàŕđ öüţþüţ éẋþļîçîţļý. Đéƒàüļţ îš šţàñđàŕđ öüţþüţ.
-r, --recursiveŔéçüŕšé îñţö đîŕéçţöŕý àŕĝüḿéñţš.
--target LOCALEÇöñṽéŕţ ţĥé ţŕàñšļàţîöñ ƒöŕ LOCALE îñšţéàđ öƒ ţĥé šöüŕçé.
-f, --formatÖṽéŕŕîđé îñþüţ ƒöŕḿàţ đéţéçţîöñ (é.ĝ. -f docling).
--source-langŠöüŕçé ļàñĝüàĝé (đéƒàüļţ en).
--encodingÎñþüţ/öüţþüţ éñçöđîñĝ (đéƒàüļţ UTF-8).

Ŵŕîţîñĝ ţö à đîŕéçţöŕý​

Àñ öüţþüţ đîŕéçţöŕý îš çŕéàţéđ îƒ îţ đöéš ñöţ éẋîšţ. Éàçĥ îñþüţ ƃéçöḿéš <name>.<ext> üñđéŕ îţ, ŵĥéŕé <ext> îš ţĥé ţàŕĝéţ ƒöŕḿàţ'š öŵñ éẋţéñšîöñ, àñđ šüƃ-đîŕéçţöŕîéš àŕé ḿîŕŕöŕéđ ŕéļàţîṽé ţö ţĥé đééþéšţ đîŕéçţöŕý éṽéŕý îñþüţ šĥàŕéš, šö kconv 'docs/**/*.md' --to html -o site/ ŵŕîţéš site/guide/intro.html ƒöŕ docs/guide/intro.md, àñđ ţŵö ƒîļéš öƒ ţĥé šàḿé ñàḿé îñ šîƃļîñĝ đîŕéçţöŕîéš çàññöţ çöļļîđé.

Ţŵö îñþüţš ţĥàţ ŵöüļđ ŕéšöļṽé ţö ţĥé šàḿé öüţþüţ ƒîļé (report.md àñđ report.html ƃöţĥ çöñṽéŕţéđ ţö ĐöçĻàñĝ) àŕé ŕéþöŕţéđ àš àñ éŕŕöŕ àñđ ñéîţĥéŕ îš ŵŕîţţéñ, àñđ šö îš à çöñṽéŕšîöñ ţĥàţ ŵöüļđ ŵŕîţé öṽéŕ îţš öŵñ îñþüţ. Ţĥé ŕéšţ öƒ ţĥé ŕüñ çöñţîñüéš; ţĥé éẋîţ šţàţüš îš 2.

Ŵîţĥöüţ à đîŕéçţöŕý, -o ñàḿéš à šîñĝļé öüţþüţ ƒîļé àñđ ţàķéš à šîñĝļé îñþüţ.

Ƒàîţĥƒüļ ṽš. çļéàñ​

Çöñṽéŕţîñĝ ţö ţĥé šàḿé ƒöŕḿàţ îš à ƒàîţĥƒüļ ŕöüñđ-ţŕîþ: éṽéŕýţĥîñĝ, îñçļüđîñĝ šţýļîñĝ àñđ ñöñ-ţŕàñšļàţàƃļé çöñţéñţ, îš þŕéšéŕṽéđ (šéé ķšéđ ƒöŕ ţĥé šàḿé ƒîđéļîţý). Çöñṽéŕţîñĝ ţö à đéŕéñţ ƒöŕḿàţ îš à çļéàñ þŕöĵéçţîöñ: à .docx → .md ķééþš ţĥé đöçüḿéñţ'š šţŕüçţüŕé àñđ þŕöšé ƃüţ ñöţ îţš Ŵöŕđ-šþéçîƒîç þàçķàĝîñĝ. Îñļîñé ƒöŕḿàţţîñĝ îš ŕéñđéŕéđ ƒŕöḿ éàçĥ ŕüñ'š ṽöçàƃüļàŕý ţýþé, ţĥé šàḿé ḿöđéļ ţĥé ŕéšţ öƒ ţĥé ţööļƃöẋ üšéš (šéé Îñļîñé Ƒöŕḿàţţîñĝ).