Skip to content

CHANGELOG.md

Latest commit

 

History

History
279 lines (170 loc) · 13.3 KB

CHANGELOG.md

File metadata and controls

279 lines (170 loc) · 13.3 KB
Raw

@hyperbook/types

0.23.0

Minor Changes

0.22.1

Patch Changes

0.22.0

Minor Changes

0.21.0

Minor Changes

0.20.0

Minor Changes

  • a51613f Thanks @mikebarkmin! - Add new navigation field for pages and sections, and improve styling coherence.

0.19.0

Minor Changes

  • 8f3efe1 Thanks @mikebarkmin! - Add title as an alternative to name in page and section frontmatter for better compatibility with other documentation tools like MkDocs. When both are present, name takes precedence.

Patch Changes

  • 6fb2e9a Thanks @mikebarkmin! - Fix various typos and bugs:
    • Fix "Buildung" typo in build progress messages (should be "Building")
    • Fix "lanuage" typo in error message (should be "language")
    • Fix incorrect MIME type "plain/text" to "text/plain" in dev server
    • Fix "aspectRation" typo to "aspectRatio" in types and VSCode schema
    • Fix CSS property "aspectRatio:" to "aspect-ratio:" in embed directive
    • Fix incorrect repository URL in README (openpath → openpatch)
    • Update minimum Node.js version from 12.22.0 to 18

0.18.0

Minor Changes

  • #1023 ffe7e4b Thanks @copilot-swe-agent! - Add llms.txt file generation feature. When the llms property is set to true in hyperbook.json, a llms.txt file will be generated during build that combines all markdown files in order. The file includes the book name and version in the header. Pages and sections with hide: true are automatically excluded from the generated file.

0.17.0

Minor Changes

  • #1017 ae25b60 Thanks @copilot-swe-agent! - Add page layout options with automatic iframe detection

    • Added three layout options: default, wide, and standalone
    • Wide layout provides full-width content with drawer-only navigation, ideal for tables, galleries, and code examples
    • Standalone layout displays content only (no header, sidebar, footer) for clean iframe embedding
    • Standalone mode can be activated via frontmatter (layout: standalone), URL parameter (?standalone=true), or automatic iframe detection
    • Automatically hides TOC toggle and QR code buttons when in standalone mode
    • Zero-configuration embedding: pages automatically switch to standalone mode when embedded in iframes
    • Added comprehensive documentation in Advanced Features section with usage examples and demos
    • All changes are backward compatible with existing pages

0.16.0

Minor Changes

0.15.2

Patch Changes

0.15.1

Patch Changes

  • c18ba75 Thanks @mikebarkmin! - Fix colons in headings not working. Fix spaces in filenames causing trouble. Add option to disable code highlighting and copy button for inline code blocks.

0.15.0

Minor Changes

  • b914f85 Thanks @mikebarkmin! - You can now collocate images, videos, and other additional files directly within your book directory. This means you can reference media using relative paths, making it much easier to:

    • Organize your content intuitively
    • Collaborate with others
    • Share or version-control your Hyperbook with media included

    Example usage:

    ![Image in the same directory as this markdown file](./image.png)
![Image one directory up relative to this markdown file](../image.png)

    This improvement enables a more seamless and portable authoring experience—no more managing separate static folders or absolute paths.

0.14.0

Minor Changes

  • b5a41e0 Thanks @mikebarkmin! - - 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.

0.13.0

Minor Changes

0.12.0

Minor Changes

  • #907 eaeaf29 Thanks @mikebarkmin! - Add option to enable search. Just set the search key to true in your hyperbook config and a search icon will be visible in the top right hand corner.

0.11.0

Minor Changes

  • d9f0b71 Thanks @mikebarkmin! - Allow permaids to be set in the frontmatter of a page. The permaids can be use in links and in the frontmatter for next and prev. See the page configuration documentation for details. All pages with permaids are available at /@/[permaid].

0.10.0

Minor Changes

0.9.0

Minor Changes

  • #882 26ae87e Thanks @mikebarkmin! - The release is a complete rewrite of the underlying process to generate the HTML files. React was removed from the project and replaced with remark plugins. This improves build times and give us more control over the whole process. For example there is no need anymore for running npx hyperbook setup.

    I also added a new pagelist directive, which can be used to list pages based on user-defined criteria. This directive also replaces the included glossary page. Therefore, you need to create on yourself. This can be easily done by creating a page glossary.md with the following content:

    ---
name: Glossary
---

::pagelist{format="glossary" source="href(/glossary/)"}

    Additionally, I added the ability to use custom JavaScript and CSS-files - see the documentation under Advanced Features - in addition to using HTML in your hyperbook, when the allowDangerousHtml option is enabled in your config.

    I also improved the appearance of custom links, by moving them to the footer on mobile devices.

0.8.1

Patch Changes

0.8.0

Minor Changes

  • 90c99bd Thanks @mikebarkmin! - Add prev and next properties to pages. This will allow you to set the prev and next buttons to an individual page by using the absolute path to the page.

0.7.0

Minor Changes

0.6.1

Patch Changes

0.6.0

Minor Changes

0.5.0

Minor Changes

  • 104f2de Thanks @mikebarkmin! - Repo can now be configured. So you can customize the label of the edit button on a page and you can insert the current path anywhere in the link, by using "%path%" placeholder.

0.4.0

Minor Changes

  • #392 8d53899 Thanks @mikebarkmin! - Extract core funcationality from platfrom web into separate packages. This helps us to support more platforms.

0.3.0

Minor Changes

  • #371 5a287b2 Thanks @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 build and hyperbook setup received new command line outputs. This was necessary for not getting lost when using the CLI with a Hyperlibrary.

0.2.0

Minor Changes

  • #363 5ca2ccf Thanks @mikebarkmin! - Add custom links support. Custom links can now be configured in your hyperbook.json. See the book configuration documentation for more information on how to set them up.

0.1.0

Minor Changes

  • #326 9472583 Thanks @mikebarkmin! - Add configuration options to the hyperbook.json for the element bookmarks and excalidraw.

0.0.1

Patch Changes