[Feature idea] In-page TOC

  • Resolved cpoakl

    (@cpoakl)


    1 month, 4 weeks ago

    Hello,
    Thanks for that great plugin!

    Here is a feature idea: being able to optionally add a TOC for each documentation page. I guess that could parse <h2> to <h*> elements in the page and create a hierarchical list out of it to be displayed either at the top of the page, or maybe added in the hierarchy of the existing left TOC menu (as subpoints for each documentation pages).

    Would there be a repo accepting external contribution, I might have a look into it.

Viewing 3 replies - 1 through 3 (of 3 total)
  • Plugin Author PluginRx

    (@apos37)

    1 month, 4 weeks ago

    Hi @cpoakl, I could look into it as time permits. Thanks for the suggestion. 🙂 There is a repo and I do accept contributions if you’re interested: https://github.com/apos37/admin-help-docs

    Plugin Author PluginRx

    (@apos37)

    1 month, 3 weeks ago

    Alright, @cpoakl, I added it. Please update to version 1.3.7, then navigate to Settings and enable “Auto-Generate TOC from Headings”. Then check out your main documentation page and open a doc that has headers (<h2> – <h6>). It will appear at the top of the page underneath the title and meta data (see screenshot). Let me know if that is what you imagined. 🙂

    Thread Starter cpoakl

    (@cpoakl)

    3 weeks ago

    Sorry for my late feedback.
    I have just enabled the option, and yes that’s precisely what I imagined! Very nice, thanks a lot!
    What I like also is that it now enables to reliably link to a given heading (e.g: https://mydomain.tld/wp-admin/admin.php?page=admin-help-docs&tab=documentation&id=21468#my_heading)!

    PS: Maybe you would like to add the repo to the WordPress plugin page (like under “plugin’s website”).

    • This reply was modified 3 weeks ago by cpoakl.
    • This reply was modified 3 weeks ago by cpoakl.
    • This reply was modified 3 weeks ago by cpoakl.
    • This reply was modified 3 weeks ago by cpoakl.
Viewing 3 replies - 1 through 3 (of 3 total)
  • You must be logged in to reply to this topic.