Skip to content

DreadBoy/glyphmark

Repository files navigation

Glyphmark

Convert Pathfinder 2e Glyph markup to styled, self-contained HTML or PDF.

This repository is an Nx monorepo containing the Glyphmark parser/renderer, a CLI that wraps it, and a handful of internal tooling libraries used while authoring fixtures from the source rulebooks.

Projects

Project Path Description
@glyphmark/cli apps/cli Command-line tool. Reads a .glyph file, writes .html or .pdf.
@glyphmark/core libs/core Parser and HTML/PDF renderer. The engine behind the CLI; also usable as a library.
extract libs/extract Node scripts for pulling single pages out of source PDFs and previewing their text-box layout. Author-time tooling.
books libs/books Source Pathfinder 2e PDFs and per-page extracts used as visual references for fixtures. Data only, no code.

See each project's README for details:

Development

The workspace uses Nx with npm. Common tasks:

# install
npm install

# build everything
npx nx run-many -t build

# build a single project
npx nx build @glyphmark/core
npx nx build @glyphmark/cli

# run tests (core has the bulk of them, including visual goldens)
npx nx test @glyphmark/core

# run the CLI from source
npx nx run @glyphmark/cli:run -- input.glyph output.html

License

Source-available under the Elastic License 2.0. Personal and internal use are free; you may not offer this software to third parties as a hosted or managed service. See LICENSE for the full terms.

About

Convert Pathfinder 2e Glyph markup to styled, self-contained HTML or PDF.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors