Version 4.4 (WIP)

Release Notes tell you what’s new in Academic. As always, we welcome your feedback. You can also file a bug report. Want to update to this version? Refer to the update guide in conjunction with the parameter changes mentioned in the Breaking Changes section below.

This version is currently in development! It corresponds to the latest master branch on GitHub. Check back here for the final notes once it is released.

See what’s new in Academic!

Welcome to the v4.4 release of Academic. There are a number of exciting updates in this version that we hope you will like, including:

  • Generate diagrams and flowcharts from text, in a similar manner as Markdown
    • See Diagrams section below
  • New Strawberry theme (see below)
    • To try it out, set color_theme = "strawberry" in config/_default/params.toml
  • The Page Sharer buttons can now be easily customized
    • Select which social networks to show and configure the order of the sharing buttons
  • Flexibility to write image gallery captions using Markdown and emojis
  • Automatically highlight the active page section in the table of contents displayed in the right sidebar (for pages using the docs layout)
  • Add support for page bundles when using the docs layout
    • Enables placing course/documentation files within their own folder, e.g. courses/example/intro.md can be renamed to courses/example/intro/index.md if desired

Diagrams

You can generate diagrams and flowcharts from text, in a similar manner as Markdown.

Just add diagram: true to a page’s YAML front matter and insert your Mermaid diagram syntax in the Diagram shortcode and that’s it. For example,

{{< diagram >}}
graph LR;
    A[Hard edge] -->|Label| B(Round edge)
    B --> C{Decision}
    C -->|One| D[Result one]
    C -->|Two| E[Result two]
{{< /diagram >}}

renders as

graph LR; A[Hard edge] -->|Label| B(Round edge) B --> C{Decision} C -->|One| D[Result one] C -->|Two| E[Result two]

Strawberry theme

New Strawberry theme.

Breaking changes

Here are some considerations to make when updating Academic from the previous version, v4.3:

Docs

  • Automatically highlight the active page section in the table of contents displayed in the right sidebar

Misc

  • for personal sites, link a superuser’s profile box to the homepage rather than their profile page
  • fix case where social sharing links are empty
  • style: make tables responsive (fixes display issues with wide tables)
  • convert archetypes from TOML to YAML
  • fix Academic’s RSS template not applied to sections or taxonomies
  • fix font-family for code snippets no longer loaded from font theme
  • fix Gallery captions not loading when using Gallery in Widget Pages

Languages

  • Add Romanian
  • Update German, French, Spanish, Portuguese

Thank you

Last but certainly not least, a big Thank You to all the folks that helped to make Academic even better.

Has Academic helped you? Please consider supporting Academic.