Installation

Add gukhanmun to your Cargo.toml:

cargo add gukhanmun

Feature flags

All features are enabled by default. Disable the ones you do not need to reduce compile time and binary size:

FeatureWhat it addsDefault
htmlHTML fragment conversionyes
markdownMarkdown conversionyes
fstFST dictionary backend (.gukfst files)yes
cdbCDB dictionary backend (.gukcdb files)yes
stdictBundled Standard Korean Dictionary (~3 MB)yes
opendictBundled Open Korean Dictionary (우리말샘, ~8 MB)yes

To build without the bundled dictionary (useful when you supply your own):

cargo add gukhanmun --no-default-features -F fst

To build a minimal plain-text-only binary:

cargo add gukhanmun --no-default-features -F stdict