doc-convert Command Line Tool

Convert Word (.docx) manuscripts into MyST projects suitable for publishing — structured myst.yml, article.md, extracted figures, citations, and author metadata.

The CLI runs a fixed pipeline (Pandoc → cleanup → figures/tables/crossrefs → citations → ROR enrichment). Example inputs for this monorepo live under ../docx-examples/; conversion quality is tracked in ../gap-analysis/.

Install

You need Bun and Pandoc on your PATH.

cd doc-convert
bun install
bun run build

Optional: link the CLI globally (bun link after build).

Quick start

Convert one manuscript (writes to _improved/ under the project root):

bun src/index.ts path/to/manuscript.docx --project-root path/to/project --workdir _improved

From the monorepo root, run all bundled examples:

../scripts/convert-docx-examples.sh

List all 13 pipeline steps with planned [run] / [skip] / [warn-skip] dispositions (no workdir, no Pandoc):

bun src/index.ts path/to/manuscript.docx --list-steps

Optional per-directory pipeline config — run from the project directory where you convert:

cd path/to/project
bun ../../doc-convert/src/index.ts configure
bun ../../doc-convert/src/index.ts manuscript.docx --list-steps   # preview after edits

Documentation

Full author guide, CLI reference, and pipeline details: docs/ (guide, reference).

License

MIT — see LICENSE.

Made with love by Continuous Science Foundation