jsonresume-docx

Generate a Word (.docx) document from a JSON Resume file.

The JSON Resume ecosystem has great HTML themes and PDF export via resumed. DOCX was the missing piece. This fills that gap.

Install

# CLI (global)
npm install -g jsonresume-docx

# Programmatic use (local)
npm install jsonresume-docx

CLI

# Uses resume.json → resume.docx by default
jsonresume-docx

# Custom input / output
jsonresume-docx --input my-resume.json --output my-resume.docx

# Help
jsonresume-docx --help

Programmatic API

const { generate, generateFile } = require('jsonresume-docx');

// Returns a Buffer — pipe it, upload it, do what you like
const buffer = await generate(resumeObject);

// Write directly to disk
await generateFile(resumeObject, './my-resume.docx');

Schema coverage

Full coverage of the JSON Resume schema. Every section is rendered if present — nothing is silently dropped. Sections are omitted cleanly when not supplied, so a minimal file works just as well as a fully loaded one.

| Section | Fields rendered | |---|---| | basics | name, label, summary, email, phone, location (city/region), url | | basics.profiles | LinkedIn shown inline; all other networks listed separately | | work | position, company, dates, highlights (falls back to summary if no highlights) | | volunteer | position, organisation, dates, highlights | | education | qualification, institution, dates, grade/score, courses | | projects | name, url, dates, description, highlights | | skills | name, level, keywords | | certificates | name, issuer, date, url | | awards | title, awarder, date, summary | | publications | name, publisher, date, url, summary | | languages | language, fluency | | interests | name, keywords | | references | name, quoted reference text |

Custom extension fields

These non-standard fields are used by the jsonresume-theme-craftedbycode-* HTML themes. They are entirely optional — standard JSON Resume files work without them.

| Extension field | Rendered as | |---|---| | stack | Subtitle line under name in header | | industries | Industry list under Skills | | strengths | "What I Bring" section | | learning | "Currently" / learning section |

Use with resumed (HTML + DOCX from one file)

Pair this tool with resumed to get both an HTML page and a Word document from the same resume.json:

npm install -g resumed jsonresume-docx

# Pick any JSON Resume HTML theme
npm install -g jsonresume-theme-even

# Render HTML
resumed render resume.json --theme jsonresume-theme-even --output resume.html

# Generate DOCX
jsonresume-docx --input resume.json --output resume.docx

Example

See examples/jane-dodds.json for a fully-populated JSON Resume file covering every section.

Attribution

• Built on the JSON Resume open schema standard.
• DOCX generation powered by docx by Dolan Miu (MIT).
• Created by Shane Kingsley.

Licence

MIT — see LICENSE.
Issues and PRs welcome at github.com/shanekingsley/jsonresume-docx.