Hyperbook Support for Visual Studio Code

Complete tooling for authoring Hyperbooks in Visual Studio Code. This extension provides live preview, snippets, auto-completion, syntax highlighting, and schema validation for Hyperbook projects.

All you need for writing Hyperbooks (auto preview, snippets, auto-completion and more).

Features

Preview

You can preview your Hyperbook pages by clicking the preview icon in the top right-hand corner or by running the command Show side preview.

Hyperbook Config

The hyperbook.json is validated against a schema, which presents you from making mistakes. It also enables a color picker for your brand color.

Syntax Highlighting

Each element has its own syntax highlighting. So you know when you typed it right.

Snippets

Each element can be inserted by using a snippet. Type : and hit your auto-completion key combo (default Ctrl+Space).

Auto completion

• Glossary terms

  • Move your cursor between the curly braces of a term/t element, e.g.: :t[My term]{
  • Type # to trigger the completion

• Link to book pages

  • Type / to trigger the completion

• Link to files in the public folder

  • Type / to trigger the completion

• Archives

  • Move your cursor in the src parameter of an archive element, e.g.: :archive[My archive]{src=
  • Type " to trigger the completion

Changelog

See CHANGELOG for more information.