Skip to content

Repository files navigation

Render Yozora AST into HTML strings, with standalone styles or Tailwind CSS v4 integration.

  • @yozora/html — shared renderer contexts, types and escaping.
  • @yozora/html-gfm — GFM core nodes, matching @yozora/parser-gfm.
  • @yozora/html-gfm-ex — GFM extensions: tables, strikethrough and task lists.
  • @yozora/html-yozora — complete rendering, including admonitions, footnotes and math.
  • Demo — run pnpm demo to compare both styles at http://127.0.0.1:7301/.

Development

Use pnpm 12.3.4 and Node.js 22.22.1+, 24.11.0+ or 26.x.

pnpm install --frozen-lockfile
pnpm typecheck
pnpm lint
pnpm build
pnpm test:build --sourcemap
pnpm test:coverage

pnpm build builds all four libraries and the private demo. pnpm build:production omits library source maps; verify it with pnpm test:build --no-sourcemap. pnpm format applies Biome fixes. See the test guide for focused runs and snapshots.

Releases

The four renderer packages are published; @yozora/demo remains private.

  1. Update the renderer packages' package.json versions and CHANGELOG.md files, then run pnpm docs:links and pnpm install --lockfile-only.
  2. Run pnpm run :publish:prepare and pnpm run :publish:verify to build and validate locally.
  3. Review and commit the changes, then run pnpm run :publish from main.

Publishing repeats the validation and publishes unpublished versions; it does not create version bumps or Git tags. Use pnpm run :publish-recover to retry an interrupted release.

License

MIT

About

Render yozora ast into html

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages