| title | linkTitle | author | date | cSpell:ignore |
|---|---|---|---|---|
Docsy 0.10.0 release report |
Release 0.10.0 |
[Patrice Chalin](https://github.com/chalin) ([CNCF](https://www.cncf.io/)), for the [Docsy Steering Committee](/blog/2022/hello/#introducing-the-psc)
|
2024-04-30 |
CNCF Chalin subdir |
The big news with Docsy 0.10.0 is color themes and dark mode!
In this release, Docsy's Hugo dependency is upgraded to 0.125.4 from 0.122.0. An important thing to note here is that Hugo 0.123.0 was a significant upgrade that included some breaking changes. Before upgrading to this Docsy version, review Hugo's deprecation notices and breaking changes since 0.122.0.
{{% alert title="Hugo version support reminder" color="primary" %}}
Each Docsy version officially only supports the Hugo version specified in the project's package.json entry for hugo-extended. Any other compatibility is on a best effort basis.
{{% /alert %}}
A number of updates to this release were to address Hugo's deprecation notices. For the complete list, search for 0.10.0 release changes with "deprecat" in the title.
The main feature of this release is the Upgrade to Bootstrap 5.3 #1528 from 5.2. This minor Bootstrap release introduces support color modes, also called color themes.
As a validation of this upgrade, Docsy has been enhanced to support dark mode, the most upvoted Docsy enhancement request (#331) prior to this release.
To learn how to enable a light/dark mode dropdown menu for your project, see Light/dark mode menu. We have enabled this menu for the Docsy User Guide, so if you're reading this post online, give dark mode a try!
{{% alert title="Important style changes" %}}
The styling of the following shortcodes and page elements have been adjusted to ensure that they are compatible with light and dark modes.
You'll needs to revisit your styles if you customized the SCSS associated with these shortcodes and elements.
The search box styling as well as the doc-page left-nav have had their styles adjusted as well.
{{% /alert %}}
For the complete list of changes in this release, see the 0.10.0 release entry and issue Release 0.10.0 preparation #1759.
Which Docsy improvements are on the horizon? For work items tentatively planed for the next release, see Release 0.11.0 preparation #1944.
{{% alert title="Vote" color="primary" %}}
If you'd like a feature or fix to be considered for inclusion in an upcoming release, remember to upvote (with a thumbs up) the associated issue or PR.
{{% /alert %}}