Hyperbook
Hyperbook is a quick and easy way to build interactive workbooks, that support modern standards and run superfast. It works by compiling markdown to static pages.
Hyperbook makes writing interactive workbooks super simple while providing a good feature set.
You do not need any coding experience. You only need to create and edit Markdown files.
Getting Started
You can start working on a Hyperbook in three different ways. Choose the one which suits your style best.
- Install VS Code or VS Codium
- Install the Hyperbook Extension for VS Code or VS Codium
- Download the hyperbook-anywhere starter
- Unzip the file
- Open the folder in VS Code
- Run the
Hyperbook: Show side previewcommand
You need to have Node version 16 or higher installed on your system.
- Run
npx hyperbook new my-new-hyperbookand follow the wizard to create your first Hyperbook. - Run
npx hyperbook devto start the development server. - Visit https://localhost:3000 with your favorite web browser.
- Modify or add new pages to your Hyperbook by using your favorite editor.
Most platforms for collaborative version control have an integrated Web IDE like GitLab or GitHub.
So you can just fork one of our starters and get going:
- GitHub: https://github.com/mikebarkmin/hyperbook-github-pages/fork
- GitLab: https://gitlab.com/mikebarkmin/hyperbook-gitlab-pages/-/forks/new
- EduGit: https://edugit.org/mikebarkmin/hyperbook-edugit-pages/-/forks/new
If you use this approach you will not be able to see a representative preview. In most cases only a normal Markdown preview, which lacks some features of Hyperbook.
Deploy
The main goal of writing a Hyperbook is to have an interactive workbook. For this you have to deploy the exported Hyperbook to a host.
Luckily GitHub Pages, GitLab Pages and Vercel are free to use options, which are already setup for you, if you used one of our starters, like hyperbook-anywhere.
You just have to push your files to GitHub, GitLab or EduGit.
If you use the CLI version you can also export your Hyperbook to static HTML files, which can be uploaded anywhere. For this you need to run:
npx hyperbook buildThen you need to copy the files from .hyperbook/out to your desired location.
Do not forget to set a basePath in your hyperbook.json.
Update
Updates should happen automatically.
Update to the latest release of Hyperbook CLI using the following command.
npm update hyperbook --globalNo Integration. No updates.
Support
We are happy to hear from you, if you need custom support or features for your application.
You can also join our Matrix Channel or connect with us on Twitter.
Hyperbook is maintained by OpenPatch, an organization for educational assessments and training. If you need help or create a Hyperbook get in touch.