BORROWDALEJS / START HERE

BorrowdaleJS documentation

BorrowdaleJS is a TypeScript toolkit for hand-drawn charts, shapes, text and patterns. The public name is BorrowdaleJS; package imports use the @borrowdale scope.

The first release, 0.1.0, is in preparation and not yet on npm. Until then, start with the local workspace, then explore the same APIs used by the playground and examples.

Start here

• Getting started: Node 24, workspace setup and your first chart.
• Cartesian charts and annotations: intervals, numeric paths, markers, labels, gradients and chart compositions.
• Rendering and fonts: SVG, Canvas, font loading and deterministic seeds.
• Accessibility and limitations: descriptions, alternatives and supported behavior.

Package reference

• Charts: chart families, data contracts, axes, legends and renderers.
• Shapes: geometry, styles, SVG and Canvas drawing.
• Text: measuring, layout, fallback glyphs and Excalifont.
• Fills: repeatable background patterns.

These are the same Markdown files rendered on the website. Changes to an API and its documentation belong in the same pull request.