Convert Markdown to HWP (Hangul Word Processor) format
npm install md2hwpConvert Markdown files to HWP (Hangul Word Processor) format. This library supports HWPX (HWP 5.x), the XML-based format used by Hancom Office.
- ✅ Convert Markdown to HWP format (HWPX/HWP 5.x)
- ✅ Verified Working with Hancom Office 2020+
- ✅ Professional heading hierarchy (H1-H6 with graduated font sizes)
- ✅ Natural line wrapping - no character spacing compression
- ✅ Improved line spacing (140%-160% for readability)
- ✅ Smart paragraph spacing - context-aware gaps between content types
- ✅ Support for paragraphs, lists, and mixed content
- ✅ Nested lists with proper indentation levels
- ✅ Text formatting: bold and italic
- ✅ Bold text in list items with mixed content support
- ✅ Tables with visible borders and proper formatting
- ✅ Korean language support (UTF-8 encoding)
- ✅ Works in Node.js environments
- ✅ TypeScript support with full type definitions
- ✅ Easy integration with React and other frameworks
- 🚧 Code blocks (planned)
- 🚧 Images (currently text placeholders)
Full support for nested/indented lists with visual hierarchy:
What Now Works:
- ✅ Nested list parsing - correctly handles multi-level list structures
- ✅ Visual indentation - each nesting level is indented by 800 HWPUNIT
- ✅ Bold text in lists - supports label: value pattern in list items
- ✅ Mixed content - handles both bold and normal text in same list item
- ✅ Recursive nesting - supports arbitrary depth of nested lists
Example:
``markdown`
- 총 예산: 35,000,000원
- 주요 항목:
- 해외 연사 항공료 및 숙박: ~10,440,000원
- 연사비: 3,400,000원
- 식사 (점심 + 만찬): 4,400,000원
Technical Details:
- Recursively parses item.tokens array from marked.js
- Uses inline with left margin for indentation
- Each level adds 800 HWPUNIT (approximately 8mm) of left margin
- Handles text tokens with inline formatting (bold/italic) within lists
After extensive debugging and analysis of the HWP format, bold text (text) now works correctly:
The Problem We Solved:
1. Character Property References: HWP's charPrIDRef uses position index, not the id attribute value
- Fixed by making all charPr IDs sequential (0-5)
2. Bold Tag Discovery: Found that HWP requires tag, not
- Analyzed user-corrected HWP file to discover the correct format
3. Font References: Bold text needs different values for non-Latin scripts
What Now Works:
- ✅ Bold inline text renders at 10pt with bold weight (same size as normal text)
- ✅ Headings render at correct sizes (H1: 14pt, H2: 13pt, etc.) with bold
- ✅ Both English and Korean bold text work correctly
- ✅ No outline boxes or unwanted borders on bold text
Technical Details:
- Uses tag instead of fontweightfontRef
- Sequential charPr IDs (0=normal, 1=bold, 2=H1, 3=H2, 4=H3, 5=H4)
- Correct values for CJK scripts when bold
This version includes significant improvements for professional HWP output:
1. Heading Hierarchy - H1-H6 headings now use different font sizes:
- H1: 14pt (1400 HWPUNIT)
- H2: 13pt (1300 HWPUNIT)
- H3: 12pt (1200 HWPUNIT)
- H4: 11pt (1100 HWPUNIT)
- H5/H6: 10pt (normal size)
2. Improved Line Spacing (줄간격):
- Headings: 140% line spacing
- Lists: 150% line spacing
- Paragraphs: 160% line spacing
- Smart vertical gaps between different content types
3. Natural Line Wrapping ✨:
- Long sentences wrap naturally to the next line
- No character spacing compression (자간 압축 해결)
- Proper text flow for both Korean and English
- Fixed the common HWP issue where long text gets compressed onto one line
See IMPROVEMENTS_SUMMARY.md for full details.
`bash`
npm install md2hwp
`javascript
const { convertMarkdownToHwp } = require('md2hwp');
const fs = require('fs').promises;
const markdown = # Hello World
This is bold and this is italic.
- Item 1
- Item 2;
const buffer = await convertMarkdownToHwp(markdown);
await fs.writeFile('output.hwp', buffer);
`
`javascript
const { convertFileToHwp } = require('md2hwp');
await convertFileToHwp('./input.md', './output.hwp', {
title: 'My Document',
author: 'John Doe'
});
`
`javascript
const { Md2Hwp } = require('md2hwp');
const converter = new Md2Hwp({
title: 'My Document',
author: 'John Doe',
pageWidth: 59528,
pageHeight: 84188
});
const buffer = await converter.convert(markdown);
`
`tsx
import React, { useState } from 'react';
import { convertMarkdownToHwp } from 'md2hwp';
function App() {
const [markdown, setMarkdown] = useState('# Hello');
const handleDownload = async () => {
const buffer = await convertMarkdownToHwp(markdown);
// Create download link
const blob = new Blob([buffer], { type: 'application/octet-stream' });
const url = URL.createObjectURL(blob);
const link = document.createElement('a');
link.href = url;
link.download = 'document.hwp';
link.click();
URL.revokeObjectURL(url);
};
return (