search

McShelby / hugo-theme-relearn

A theme for Hugo designed for documentation
https://mcshelby.github.io/hugo-theme-relearn/
MIT License
377 stars 177 forks source link

toc: add more TOC options #800

Open julienboucachard opened 6 months ago

julienboucachard commented 6 months ago

Is it possible to add an optionnal TOC menu on right like on this other template https://shadocs.netlify.app/markdown/blockquote/ But in HUGO Theme relearn as it's more nicer ?

McShelby commented 6 months ago

It is possible with a certain amount of Hugo background by overriding some of the theme files. Nevertheless this isn't an easy task.

I've plans to add more options to the toc, but currently it's not my priority.

McShelby commented 6 months ago

This was already outlined in #167.

These were the requirements and I still think they are a valid starting point:

The new TOC implementation should:

Additional:

julienboucachard commented 6 months ago

Thanks for the update, take time to make the update, that was just an improvement idea.

Le ven. 15 mars 2024, 21:40, Sören Weber @.***> a écrit :

This was already outlined in #167 https://github.com/McShelby/hugo-theme-relearn/issues/167.

These were the requirements and I still think they are a valid starting point:

The new TOC implementation should:

  • be usable on touch as on pointer devices
  • be accessible even if the page is scrolled down
  • take the least space possible
  • may have configurable behaviour (to resemble the old UX)

Additional:

  • If it's displayed inside of the content area, maybe make it collapsible

— Reply to this email directly, view it on GitHub https://github.com/McShelby/hugo-theme-relearn/issues/800#issuecomment-2000411445, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADG3FWSZ23E6FZEXFBMKMUDYYNMDHAVCNFSM6AAAAABEXYAFAWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAMBQGQYTCNBUGU . You are receiving this because you authored the thread.Message ID: @.***>