Doks v0.3

Posted October 6, 2021 by Henk Verlinde ‐ 3 min read

Version 0.3 is finally here! Better UX navigation, multilingual and i18n support, versioned documentation support, dismissible global alert, Mermaid diagrams and visualizations, and more!

Better UX navigation

Navigation Mobile Navigation Structure Mobile

No more scrolling to the bottom of a page to get to the next page! The navigation parts (global, section, and page) are now all available at the top of a browser window (all screen sizes). This setup also provides for more room for additional navigation elements (all navigation parts).

Menus →

Multilingual and i18n support

Multilingual Support

Doks now is fully prepared for multilingual and i18n support.

Multilingual Mode →

Versioned documentation support

Versioned Documentation Support

Doks now is fully prepared for versioned documentation support.

Versioned Documentation →

Global alert

Global Dismissable Alert

The global alert is now visible on all pages (not only the homepage) when activated. Switch it on by setting alert = true and make it dismissible by setting alertDismissable = true in ./config/_default/params.toml.

Alerts →

Mermaid diagrams

You can now add Mermaid diagrams and visualizations by using a shortcode (handy for adding extra classes) or code fences. Mermaid support is switched off per default. Activate it by setting mermaid = true in the front matter of a page.

```mermaid
graph TD
  A[Hard] -->|Text| B(Round)
  B --> C{Decision}
  C -->|One| D[Result 1]
  C -->|Two| E[Result 2]
```

Mermaid Code Fences

Note, this is an image, because Mermaid support is switched off on this site.

Mermaid →

Videos shortcode

You can now add locally hosted videos by using a shortcode.

{{< video ratio="16x9" attributes="controls autoplay muted" webm-src="videos/flower.webm" mp4-src="videos/flower.mp4" >}}

Videos →

Images markdown support

Now, you can also (next to using the image shortcodes) add an image using markdown (portability!). An <img> element is used for small images, a <figure> element for large images.

![Image](day-and-night-escher.jpg "Day and Night, 1938 — M.C. Escher")

Image
Day and Night, 1938 — M.C. Escher

Images →

Other features and fixes

Full changelog →

What’s next

  • Add subnavigation to menus (main + section)
  • Automatically generate menus (main + section)
  • Add Algolia Search (next to FlexSearch) as an option
  • Update blog pages (list + single)
  • Docs docs docs!

Milestones →

Contributors

Thanks for all contributions to discussions, bugfixes, features, and documentation!

32u2, AsbjornOlling, deining, FileFabrik, limichange, LunaticMuch, mikepianka, mroswell, OCram85, rslifka, sharjeelaziz, soichih, TheTimeWalker, umatare5, Yvand, and Zerotask 💪

Become a backer

Help Doks grow further by supporting us on Open Collective. Thanks!

👋 Stay in the loop

Subscribe to the Doks newsletter and get occasional updates.