CHAM Monorepo

TypeScript implementation of CHAM (Classical Han with Annotations Markup) — a structured markup format for classical Chinese texts.

Packages

Package	Description
@hanology/cham	Node.js toolchain: parser, serializer, validator, CHAM-JSON pipeline, ePub converter
@hanology/cham-browser	Site generator: pure pipeline functions, Vue 3 template, CLI (cham-browser --config config.yaml)

Install

# Node.js toolchain
npm install @hanology/cham

# Site generator
npm install @hanology/cham-browser

Quick start

Parser & Serializer

import { parse, serialize } from '@hanology/cham'

const doc = parse(chamSource)
const roundTripped = serialize(doc)

Site Generator

npx @hanology/cham-browser --config config.yaml

Development

npm install         # install all workspace deps
npm run build       # build all packages
npm test            # run tests

Requires Node.js 20+.

License

MIT