1 release 1 tag

• 0.5.0 99f03e44fd

  Compare

  ButterflyVu Release v0.5 Pre-release

  Korbs released this 2025-11-08 15:39:37 -05:00 | 0 commits to latest since this release

  Introducing ButterflyVu v0.5, which has been completely redesigned and refactored from the inside and out. Smaller, faster, and more efficient compared to previous versions; making it better for your users, deployments, and more.

  New Documentation

  All documentation for ButterflyVu have been rewritten to adjust to this release. You can view them at https://butterflyvu.sudovanilla.org/.

  Customization

  • Toggles are new options available in the configuration files to toggle certain parts of the interfaces on and off such as search, whitelabel, and more.
  • Backgrounds for the sidebar and page are now possible, you can also set the position.
  • Colors an now be adjusted for variables like branding, meta, and more. They all must be in the HSL format, not including alpha. (E.x. "224, 50%, 50%")

  All New Splash

  The splash is built to be treated as the homepage of your documentation to quickly showcase and present introduction. With the all new splash in ButterflyVu a smooth gradient glow is shown from above coming down onto the main heading, quick actions, and then so-on. Explore the new ButterflyVu documentation to see it in action.

  No More Client-Side JavaScript

  With no client-side JavaScript, your documentation will now load even faster and be more efficient for your users, reduce bandwidth overall, improved SEO and accessibility out of box, and more. You also get easier content cashing and offline distribution, quicker CI/CD deployments allowing for lower hosting costs, faster contentful paint on slower networks, and other improvements that comes with this perk. All basic functions such as search, are now being processed server-side.

  To also make there are no client-side JavaScript included with ButterflyVu, support for Zorn has been completely removed. With plans to add MDX support back in a later release, this could be used to integrate Zorn back into ButterflyVu while also overriding the deno.json file, but would add JavaScript client-side due to Zorn's full reliance on it.

  Open Graph

  In this release finally comes built-in Open Graph image support for all pages and documents, better late than never. Ensuring that every page has a slick, professional-looking embed preview including specific logo, image, title, and category; when it's shared across platforms. The Open Graph image is also fully customizable so it's tailored to your product and branding.

  All New Search-Indexing

  Pagefind has been completely dropped in favor to ButterflyVu very own built-in search solution, which is processed with server-side rendering which allows for zero JavaScript client-side. Making it fast for users browsing your documentation. Searches are now built as an index during each build of the documentation, being converted into a JSON file.

  Other Changes

  • You can now add table of contents to your documents by adding showToc: true to your Markdown file.
  • OCI image is built using denoland/deno:alpine
  • OCI image support now available for arm64
  • You can now add a custom footer slot to the bottom of the sidebar
  • CSS modules are now used to generate random class names.
  • Previous support for MDX, Prism, and SSG have been removed temporary. Plans to add back in later releases.

  Documentation | Source Code | OCI Image