Doks v0.3
Posted October 6, 2021 by Henk Verlinde ‐ 2 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
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).
Multilingual and i18n support
Doks now is fully prepared for multilingual and i18n support.
Versioned documentation support
Doks now is fully prepared for versioned documentation support.
Global 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.
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]
```
Note, this is an image, because Mermaid support is switched off on this site.
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" >}}
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.
Other features and fixes
- Update meta tags (following setup Yoast)
- Make section navigation collapsible (optionally)
- Extend alert shortcode (inline, next to named parameter)
- Automatically add copy button for code blocks (dropped copy shortcode)
- Better dark mode support (no more FART)
- Replace hugo-bin with hugo installer (verifies checksum & runs health check when installing)
- Migrate to FlexSearch v0.7.2
- Migrate to highlight.js v11.2.0
- Update to Hugo v0.88.1
- Update to Bootstrap 5.1.2
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!
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!