Hyperbook Documentation

Changelog

The entire release archive of hyperbook is available on NPM

If you need a new feature, open an issue and let's discuss.

v0.48.4

  • Fix build breaking, when a heading is in a collapsible.

v0.48.3

  • Remove unwanted console.log.

v0.48.2

  • Fix search not working.

v0.48.1

  • Fix collapsible button styles bleeding into other button styles.

v0.48.0

  • The webide element allows you to embed a web-based integrated development environment (IDE) directly into your hyperbook. This feature is particularly useful for interactive coding tutorials and exercises, enabling users to write and run code within the book itself. Learn more

v0.47.2

  • Fix tabs and collapsibles not rendering hyperbook elements.

v0.47.1

  • Development server injected the reload script at the wrong place, if there was an additional body tag. Thus, leading to unwanted behavior e.g. for the p5-element.
  • Pyide: The event listener for the run button was not removed, which lead to refreshing the page when the run button was clicked multiple times.

v0.47.0

  • Save every state of the hyperbook and make it available for download. To enable this feature, set importExport to true in the configuration file. The buttons for importing and exporting will be at the bottom of the page. The state of the hyperbook will be saved as a JSON file. The file can be imported again to restore the state of the hyperbook.
  • The code of the editor for the elements P5, Pyide, ABC-Music can now be copied, download or resetted.
  • Add i18n support. Currently, only en and de are supported. You need to set the language in the configuration file. Learn more
    • If you want to contribute a new language, please create a pull-request and add a new locale in packages/markdown/locales.

v0.46.1

  • Resolved an issue where interactive elements failed to initialize correctly after being revealed within the protect element.
  • Fixed an issue where collapsibles with the same ID were not synchronized.

v0.46.1

  • Resolved an issue where interactive elements failed to initialize correctly after being revealed within the protect element.
  • Fixed an issue where collapsibles with the same ID were not synchronized.

v0.46.0

  • Add trailingSlash option. When this option is enabled only directories and index.html files will be produced, when building the hyperbook. Learn more

v0.45.0

  • You can now add inputs and tests to your pyide element. Learn more

v0.44.0

  • A new element pyide that allows you to run python in your browser. Learn more

v0.43.0

  • A new element p5 that allows you to create p5.js sketches was added. Learn more

v0.42.0

  • Add abc-music element for creating and listing to note written in the abcnotation. Learn more

v0.41.0

  • Allow emojis in tab titles. E.g.: :::tab{title="Hi :smile:"}
Changelog
✎ GitHub© Copyright 2025 by OpenPatch