Skip to content

CHANGELOG.md

Latest commit

 

History

History
417 lines (223 loc) · 20.1 KB

CHANGELOG.md

File metadata and controls

417 lines (223 loc) · 20.1 KB
Raw

@hyperbook/fs

0.27.0

Minor Changes

  • #1164 87e7042 Thanks @mikebarkmin! - Update all dependencies to their latest versions

    Notable upgrades: Shiki 4, Mermaid 11.16, three.js 0.185, p5 2.3, Excalidraw 0.18.1, React 19.2, Express 5, TypeScript 6, ESLint 10 and Vite 8. Rendered output is unchanged.

    hyperbook-studio now requires VS Code 1.125.0 or newer.

0.26.0

Minor Changes

  • #1159 9bdb389 Thanks @mikebarkmin! - Order pages and sections together by index. Pages were always rendered before the sections of the same level, so a page could not sit after or between them. The index of a page and the index of a section are now one order, and a section that ends up between two pages is rendered between them.

    The reading order follows the navigation, so the previous and next buttons, the breadcrumb and ::pagelist agree with the sidebar.

    A page or a section without an index keeps its old place: pages come before sections, and a page wins a tie against a section. A book that gives its sections an index but leaves it off a page will see that page move behind those sections. Give the page an index to place it.

0.25.1

Patch Changes

  • 8c766ec Thanks @mikebarkmin! - dev: The dev server now tracks which files each page inlines, so a change rebuilds exactly the pages that used it.

    Editing a file referenced by a directive's src= attribute previously reloaded the browser without rebuilding anything, so the page came back showing the old content — and for a file under book/ nothing happened at all. Snippets and templates are now mapped to the pages that use them instead of forcing a full rebuild of the book.

    Two related fixes: renaming a page or changing its order rebuilds every page, because the navigation is baked into all of them and the rest were left showing the old title; and the search index is regenerated after an incremental build instead of going stale until the next full build.

0.25.0

Minor Changes

0.24.2

Patch Changes

  • 28097df Thanks @mikebarkmin! - Convert navigation bug test to proper Vitest test suite. The standalone test-navigation-bug.js has been converted to a comprehensive test file (navigation-bug.test.ts) that validates navigation behavior with proper assertions and integration with the existing test infrastructure.

0.24.1

Patch Changes

0.24.0

Minor Changes

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

0.23.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

  • db806c9 Thanks @mikebarkmin! - Fix missing handlebars helpers (like dateformat) in pagelist custom snippets. The basic helpers are now properly registered when using custom snippet templates with the pagelist directive.

0.22.0

Minor Changes

  • 285212a Thanks @mikebarkmin! - Add new Handlebars helpers for snippets and templates.

    New Helpers:

    • dateformat: Format dates with customizable patterns (YYYY-MM-DD, DD.MM.YYYY HH:mm:ss, etc.)
    • truncate: Truncate strings by character limit with configurable suffix
    • truncateWords: Truncate strings by word count with configurable suffix

0.21.2

Patch Changes

0.21.1

Patch Changes

0.21.0

Minor Changes

0.20.0

Minor Changes

0.19.0

Minor Changes

  • 7ef905d Thanks @mikebarkmin! - Add c and l variables to snippets to allow for dynamic amount of colons.

0.18.3

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.18.2

Patch Changes

0.18.1

Patch Changes

0.18.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.17.3

Patch Changes

0.17.2

Patch Changes

  • 9671fff Thanks @mikebarkmin! - The development server does not crash anymore, when an error occurs.

0.17.1

Patch Changes

0.17.0

Minor Changes

0.16.1

Patch Changes

0.16.0

Minor Changes

0.15.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.14.1

Patch Changes

  • 2074212 Thanks @mikebarkmin! - Sometimes snippets were not resolved correctly. This should fix the issue.

0.14.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.13.1

Patch Changes

0.13.0

Minor Changes

  • c500196 Thanks @mikebarkmin! - Add elements to vfile. In the future this can be used only include elements which are needed for a given page.

0.12.1

Patch Changes

0.12.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.11.3

Patch Changes

  • d723aaf Thanks @mikebarkmin! - Fix fs module for windows. This should also fix the vscode extension on windows.

0.11.2

Patch Changes

0.11.1

Patch Changes

0.11.0

Minor Changes

  • 2e67754 Thanks @mikebarkmin! - Disable caching, which caused problems. Enable the dev server to serve libraries aswell as individual book.

0.10.0

Minor Changes

0.9.0

Minor Changes

  • ff0e867 Thanks @mikebarkmin! - Improve the build of hyperbooks and the generation of the toc.

0.8.1

Patch Changes

0.8.0

Minor Changes

Patch Changes

0.7.5

Patch Changes

0.7.4

Patch Changes

  • e581f06 Thanks @mikebarkmin! - Fix bug index not found when no other sibling directories are present.

0.7.3

Patch Changes

0.7.2

Patch Changes

  • c6414c8 Thanks @mikebarkmin! - When getting the markdown content of a vfile, an empty string will be returned and a waring will be display on the console. This should lead to a better experience, when developing a hyperbook.

0.7.1

Patch Changes

  • 6fa6eba Thanks @mikebarkmin! - Fix rbase and rfile including .git in the path, which lead to files not found.

0.7.0

Minor Changes

  • ff21264 Thanks @mikebarkmin! - Add helpers for accesing the root of your project. rbase64 and rfile work find you .git directory and work from there. In contrast base64 and file work relative to your hyperbook. So rbase64 and rfile are helpful, when working in a mono-repo.

0.6.3

Patch Changes

0.6.2

Patch Changes

  • 1614352 Thanks @mikebarkmin! - Fix hyperbook not buidling when an unsupported file is present in the book or glossary folder.

0.6.1

Patch Changes

0.6.0

Minor Changes

0.5.0

Minor Changes

  • b134e02 Thanks @mikebarkmin! - Add more helpers for templates and snippets. See documentation of snippets for more details.

0.4.0

Minor Changes

  • 0c58ad8 Thanks @mikebarkmin! - Implement use a virtual file system. This allow for an abstraction layer, which enables us to implement a template system.

  • 0c58ad8 Thanks @mikebarkmin! - Add templates to Hyperbook. Templates allow for resuing a layout. See the documentation for more details.

0.3.0

Minor Changes

  • 9298af0 Thanks @mikebarkmin! - Add the snippet element. Snippets are helpful for making the handling of repeated blocks easiert. For example you can define a protect-block, which uses the same password across your hyperbook in a snippet. If you want to change the password, you can just change it in the snippet. See the documentation for snippets to get a more in detail view on snippets.

0.2.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.1.3

Patch Changes

  • 40ec0fd Thanks @mikebarkmin! - Empty section index pages now correctly link to the first non-empty subpage.

0.1.2

Patch Changes

  • af4964b Thanks @mikebarkmin! - Fix hyperbook not building when glossary folder is not present.

0.1.1

Patch Changes

  • f906c50 Thanks @mikebarkmin! - We fixed links to pages on a glossary page are not relative to book, but relative to the root of the hyperbook, which caused unresolved links.

0.1.0

Minor Changes

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