Skip to content

etigerstudio/hexo-tag-hint

Repository files navigation

hero

npm version  npm downloads  jsdelivr downloads

hexo-tag-hint is a simplistic plugin for Hexo which enables presenting a floating bubble containing the hint text when the content text gets hovered or clicked (yes, mobile-ready!).

💡 Basic Syntax

Insert this little Nunjucks snippet anywhere you want to show your hints:

{% hint 'body_text' 'hint_text' %}

Where body_text is the normal post body text, hint_text is the text that should be presented inside the hint bubble. Use \' to escape ' if necessary.

Plugin single-line screencast

E.g.:

{% hint 'misfits' 'hexo-tag-hint' %}

📖 Multi-line Support

Multi-line hints are supported right now🎉. Append additional hint text lines to build a multi-line hint:

{% hint 'body_text' 'hint_text_1st_line' 'hint_text_2nd_line' ... %}

Plugin multi-line screencast

E.g.:

{% hint 'Hexo' 'A fast, simple &' 'powerful blog framework' %}

🔌 Install & Update

Execute following one-liners to integrate this plugin into your Hexo project, or to update the plugin:

$ npm install hexo-tag-hint # install this plugin
$ npm update hexo-tag-hint # update the plugin
$ npm install hexo-tag-hint@latest # force update to latest version

🚀 Roadmap

  • Add support for multi-line hints
  • Strip redundant style classes
  • Make Color theme configurable
  • Make CDN configurable & switchable
  • Ensure text stability during animation

✏️Open issues to request for more features!

🙌 Special Thanks

Main feature of presenting hint bubble is heavily backed by hint.css, an awesome CSS only tooltip library.

Brought to you with ❤️ by E-Tiger Studio, 2017-2020.