Hyperlibrary

[mikebarkmin]

Introducing Hyperlibrary

A Hyperlibrary is a way to connect multiple Hyperbooks and Hyperlibraries with
each other. Hyperlibraries are a super flexible way to develop connected
Hyperbooks.

A Hyperlibrary is nothing more than a hyperlibrary.json files.
Here is an example for connecting different versions.

{
  "name": "Versions",
  "library": [
    { "src": "v1", "name": "1.0.0", "basePath": "v1" },
    { "src": "v2", "name": "2.0.0", "basePath": "/" }
  ]
}

The folder structure in this case would look like this:

documention
| v1
| | ...
| | hyperbook.json
| v2
| | ...
| | hyperbook.json
| hyperlibrary.json

As for a Hyperbook, you also have to run the hyperbook setup first.
Afterwards you can use the hyperbook build command for building your
Hyperlibrary.

The hyperbook dev command is not supported with this release. As a workaround you have to start the Hyperbooks as standalones. For example

user ~/documention $ cd v1
user ~/v1 $ npx hyperbook dev

CLI Changes

• hyperbook setup does not download the template any more from the GitHub repo, but bundles it. This should decrease bandwidth and improve setup speed.
• hyperbook can now be pinned. This results in stable deployments. You just need to use npx hyperbook@0.5.7.
• hyperbook build and hyperbook setup received new command line outputs. This was necessary for not getting lost when using the CLI with a Hyperlibrary.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
hyperbook	✅ Ready (Inspect)	Visit Preview	Oct 21, 2022 at 9:20AM (UTC)

[mikebarkmin]

This pull request sets #291 to rest. After merging, we can delete the translation branch.