Skip to content

Latest commit

 

History

History
230 lines (175 loc) · 8.65 KB

CHANGELOG.md

File metadata and controls

230 lines (175 loc) · 8.65 KB
Raw

Changelog

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

For a list of issues targeted for the next release, see the 23Q1 milestone.

0.7.0 - next planned release (unpublished yet)

New:

Breaking changes:

  • Upgraded Bootstrap (#470) to v5.2. For a list of Bootstrap's breaking changes, see the Bootstrap migration guide. Other Docsy-specific changes are listed below:
    • Clean up of unused, or rarely used, variables, functions, and mixins:
      • Dropped $primary-light
      • Dropped color-diff()
      • Dropped bg-gradient-variant() mixin (#1369)
    • Docsy's RTL support has been removed because it is incompatible with BSv5. For progress on the reintroduction of RTL support, see #1442.
  • Shortcodes:
    • Now using Hugo's native support for processing HTML & markdown, not file extension testing. (#906)
    • Dropped support for pre-Hugo-0.54.x behavior of {{% %}}. (#939)
    • blocks/section: default and accepted values of the type argument have changed! For details see blocks/section (#1472).

Other changes:

  • Non-breaking changes that result from the Bootstrap v5 upgrade:
    • Draw.io diagram edit button: replaced custom colors by BS's outline primary.

0.6.0

For the full list of the changes found in this release, see the release notes.

With this release we declare a feature freeze while we migrate to the newest Bootstrap version. See the announcement for more information.

New:

  • Simplified use of mermaid diagrams: when using a mermaid code block on your page, mermaid is now automatically enabled (needs hugo version >= 0.93.0). For existing sites build with hugo 0.93.0+, parameter mermaid.enable can be removed from site config.

  • Add render hook for chem code blocks: add auto-activation of math and chem blocks via KateX and mhchem. Support for formula rendering activation on individual pages only. Hugo version >= 0.93.0 required.

0.5.1

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:

Breaking changes:

  • Tabbed panes, text display. By default, the content of a tab inside a tabbed pane is shown as code. As of version 0.4 of the shortcode, you can add the parameter code=false to your tabpane or tab shortcode in order to render tab content(s) as text (markdown or html). As of version 0.5 the name of this parameter was changed, we now use text=true in order to mark content as text.
  • 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:

0.5.0

Unpublished.

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:

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:

0.2.0

New:

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:

  • ...