Tooltips anywhere | Voters

Tooltips anywhere

Liam

Docs are full of jargon, and it's way more convenient to get quick definitions of key terms through tooltips. Otherwise we're stuck with using hyperlinks, and people have to jump around or open a dozen tabs until they learn all the terms well enough not to have to. Tooltips are a better way!

March 23, 2021

Stefan Müller

Looks like that there are new options on the table but but both have been stalled for almost a year
https://github.com/grnet/docusaurus-terminology
https://github.com/LunaticMuch/docusaurus-terminology

Dave

This would be so useful!

Alex Simmons

It would be also great to store definitions in a single YAML/JSON glossary. The good example is at https://idratherbewriting.com/learnapidoc/docapis_glossary_section.html#reusing-glossary-definitions

Stefan Müller

there is https://gitlab.grnet.gr/terminology/docusaurus-terminology but seems work is stalled.

Even all related plugins on https://github.com/remarkjs/remark/blob/HEAD/doc/plugins.md#list-of-plugins are broken :(

Wei Wibg

As a workaround there're many existing React tooltips components (ie. https://github.com/atomiks/tippyjs-react). You can simply add it to your project (npm install / yarn add) and use it.