This project uses mise to manage the Node.js and pnpm versions declared in mise.toml. See the mise installation guide and Activate mise for setup.
git clone https://github.com/vivliostyle/vfm.git && cd vfm
# Install the Node.js and pnpm versions defined in mise.toml
mise install
# Install dependencies for all workspace packages
pnpm install
# Build every package in the workspace
pnpm build
# Expose the CLI on your PATH for local testing
cd packages/vfm
pnpm link --global
DEBUG=vfm vfmTo watch sources during development:
pnpm --filter @vivliostyle/vfm devTo run the test suite across the workspace:
pnpm testThe Markdown toolchain is being migrated from remark 8 / unified 9 to remark 13+. The umbrella issue is #275. The Phase 0 survey, the migration policy, and the list of known breaking points are in docs/dev/remark13-migration.md (Japanese: docs/ja/dev/remark13-migration.md). Every document under docs/dev/ has a Japanese counterpart under docs/ja/dev/; keep both in sync when adding or changing one.
During the migration the repository holds two trees side by side:
| Directory | Packages | Status |
|---|---|---|
packages/ |
@vivliostyle/vfm, @vivliostyle/remark-ruby, ... |
Current. Published to npm. |
packages-next/ |
@vivliostyle/vfm-next, @vivliostyle/remark-ruby-next, ... |
Next generation. "private": true, never published. |
Rules for the co-existence period:
- Every package in
packages-next/has the-nextsuffix in itsname, andworkspace:*dependencies andimportstatements between next packages use the suffixed names. This keeps pnpm--filterandworkspace:*resolution unambiguous. The suffix is removed when next replaces current. - Bug fixes for the released packages go to
packages/. Migration work goes topackages-next/. Do not apply migration changes topackages/. packages-next/has noCHANGELOG.mdand is excluded from changesets. Do not add changesets for next packages.tools/vfm-compareruns the same Markdown through both generations and reports the HTML differences (pnpm --filter ./tools/vfm-compare compare); see its README. Classify what it finds per #293.- Tests in
packages-next/compare an MDAST dump next to the HTML. Regenerate the dump with themdastscript instead of editing it by hand; see the Tests section of packages-next/README.md. pnpm-workspace.yamlcarriesoverridesandpackageExtensionsthat keep the@types/unist/unified/vfiletype resolution of each tree on its own major. When you add a dependency topackages-next/that also exists inpackages/at an older major, runpnpm buildat the root to confirm both trees still compile. See breaking point 19 in docs/dev/remark13-breaking-points.md.pnpm buildandpnpm testat the repository root run both trees. To work on one tree only:
pnpm --filter "./packages-next/*" build
pnpm --filter "./packages-next/*" test
pnpm --filter @vivliostyle/vfm-next devPlease refer to Semantic Commit Messages for the commit comment.
For each user-facing change, add a changeset: run pnpm changeset and commit the generated .changeset/*.md.
Releases are automated with Changesets and published to npm through OIDC trusted publishing.
Pending changesets on main drive a "Version Packages" pull request. Merging it makes the workflow publish the changed packages to npm and create the matching git tags and GitHub Releases.