CHANGELOG.md

Changelog

Useful links: Docsy releases & tags. Jump to the latest release.

For a list of issues targeted for the next release, see the 22Q2 milestone.

0.5.0 - next planned release (unpublished yet)

For the full list of the changes found in this release, see the release notes. BREAKING CHANGES are documented below.

After you update your project's Docsy:

• Update your project setup (see 0.4.0) if you haven't already.
• Run npm install.

New:

• Projects can now install and use Docsy as an NPM package.

Breaking changes:

• Display logo by default. Most projects show their logo in the navbar. In support of this majority, Docsy now displays a logo by default. For details on how to hide the logo (or your brand name), see Styling your project logo and name.
• Upgraded Bootstrap to v4.6.2 from v4.6.1, resulting in some style changes (such as an adjustment in the size of small). For details, see v4.6.2 release notes.
• Upgraded FontAwesome to v6 from v5. While many icons were renamed, the v5 names still work. For details about icon renames and more, see What's changed.
• Search-box: the HTML structure and class names have changed, due to the Font Awesome upgrade, for both online and offline search. This may affect your project if you have overridden search styling or scripts.

Other changes:

• By default, Docsy now uses the gtag.js analytics library for all site tags. For details, see Adding Analytics > Setup.

0.4.0

For a full list of the changes to this release, see the release notes. Potential BREAKING CHANGES are documented below.

After you update your project's Docsy, run npm install.

Update your project setup

If your project uses Docsy as follows:

• Hugo Module, then this change doesn't impact you.
• For other Docsy setups, this is a BREAKING CHANGE -- read on.

Docsy now fetches Bootstrap and FontAwesome as NPM packages rather than git submodules. This has an impact on your project-build setup. To migrate your site, follow these steps (execute commands from your project's root directory):

1. Delete obsolete Docsy Git submodules:

   $ rm -Rf themes/docsy/assets/vendor

2. Get Docsy dependencies:

   $ (cd themes/docsy && npm install)

3. Update your build scripts to fetch Docsy dependencies automatically. For example, if your site build uses NPM scripts, consider getting Docsy dependencies via a prepare script as follows:

   {
     "name": "my-website",
     "scripts": {
       "prepare": "cd themes/docsy && npm install",
       "...": "..."
     },
     "...": "..."
   }

4. (Optional) Build script cleanup. If your project uses Docsy as a git submodule, Docsy updates no longer require the --recursive flag when running git submodule update. Consider dropping the flag if you have no other recursive git submodules.

Proceed as usual to build or serve your site.

0.3.0

For a full list of the changes to this release, see the release notes.

Breaking changes:

• Upgrade to Algolia DocSearch v3. If your site uses the deprecated DocSearch v2, you must update your DocSearch code.
• (Edit) PR #1009 inadvertently changed the base Bootstrap styles for cards, as well as the Docsy highlight style. For details, see issue #1154. Release 0.5.0 includes a fix.

0.2.0

New:

• Add official Docsy support for Hugo modules. Many thanks to the dedicated and patient efforts of @deining, who researched, experimented, and implemented this feature. Thanks to @deining and @LisaFC for the doc updates.

  For details, see Migrate to Hugo Modules.

Details:

• For a full list of the changes to this release, see the release notes

0.X.Y - next planned release (unpublished yet)

For a full list of the changes to this release, see the release notes.

Breaking changes:

• ...