Hyperbook is a quick and easy way to build interactive workbooks, that support modern standards and runs superfast.
- Documentation: https://hyperbook.openpatch.org
- Repository: https://github.com/openpatch/hyperbook
- Community: https://matrix.to/#/#openpatch:matrix.org
This monorepo contains the following packages:
- hyperbook - Main CLI tool for creating, building, and serving Hyperbook projects
- @hyperbook/markdown - Markdown processing engine with 30+ custom directives
- @hyperbook/fs - File system utilities for managing Hyperbook projects
- @hyperbook/types - TypeScript type definitions for the Hyperbook ecosystem
- create-hyperbook - Interactive CLI for scaffolding new Hyperbook projects
- @hyperbook/web-component-excalidraw - Excalidraw web component for diagrams
- hyperbook-studio - Visual Studio Code extension with preview, snippets, and validation
If you want to work on the documentation, run the development server and edit the files in the website folder.
pnpm install
pnpm build
pnpm website:dev
If you want to work the vscode extension:
pnpm install
pnpm build
pnpm --filter hyperbook-studio watch
pnpm --filter hyperbook-studio open
Mike Barkmin • Mastodon • GitHub
We are happy to hear from you, if you need custom support or features for your application.
Hyperbook is maintained by OpenPatch, an organization for educational assessments and training. If you need help or you created a Hyperbook get in touch.