Skip to content

Repository files navigation

tw-excalidraw

A whiteboard plugin using Excalidraw.

Demonstration and documentation at https://itsthewhale.github.io/tiddlywiki-excalidraw.

Development

Installing dependencies

Please only use pnpm, as this project depends on pnpm-specific functionality.

$ pnpm install

Regenerating Excalidraw patches

A script programmatically patches the Excalidraw package and generates a pnpm patch file to be committed to the repository. Do not attempt to manually patch the package, all changes must be made via the patch script or the changes will be overwritten the next time patches are regenerated.

$ pnpm run patch:excalidraw

Development server

Read-only wiki

$ pnpm run dev

Editable wiki

$ pnpm run dev:wiki

Editing

Formatting

$ pnpm run format

Linting

$ pnpm run lint

Type checking

$ pnpm run check

Publishing

Library

$ pnpm run build

Online wiki

$ pnpm run publish

Releases

Packages

Contributors

Languages