dlvhdr / gh-dash

A beautiful CLI dashboard for GitHub 🚀
https://dlvhdr.github.io/gh-dash
MIT License
7.06k stars 208 forks source link

(MAINT) Update docs theme #282

Closed michaeltlombardi closed 1 year ago

michaeltlombardi commented 1 year ago

Summary

This change updates the configuration and version of the docs theme to the latest version of Platen and opts-into the new display modes.

This update includes a fix to a build error caused by the Platen reimplementing the TOC building logic and ensures that the docs site builds correctly without errors or warnings.

The new opt-in features gets the docs site ahead of the eventual deprecation and removal of legacy functionality and keeps the build logs clean. It also ensures:

  1. The site can more effectively use icons.
  2. The TOC nodes with nested items can be collapsed.
  3. The mobile buttons are more usable and accessible.
  4. The site-level icons are configurable and can be kept cohesive.

Finally, the change moves the remaining Platen configuration out of the hugo.yaml file, colocating it with the rest of the Platen-specific configuration in docs/data/_params/platen.yaml.

How did you test this change?

Local testing of the docs site with hugo serve.

Images/Videos

N/A