Tooltips

Add hover explanations for terms, acronyms, or jargon.

Basic Usage

Docyard uses GFM for content.

Hover over “GFM” above to see the tooltip.

Add a link for users who want more information:

The site is built with an SSG.

Custom Link Text

Change the default “Learn more” text:

Configure your DNS settings for your custom domain.

Technical Acronyms

Use tooltips to explain technical terms without cluttering your prose:

The CLI provides commands for building and serving your site. Configure TLS certificates for HTTPS.

Product Terms

Explain product-specific terminology:

Enable hot reload for faster development.

The sidebar is configured in YAML.

In Tables

Feature Description
SSR Not supported
SSG Fully supported
ISR Not supported

Syntax 

:tooltip[term]{description="Explanation text"}

:tooltip[term]{description="Explanation" link="https://..."}

:tooltip[term]{description="Explanation" link="https://..." link_text="Custom text"}

Reference

Attribute Required Default Description
description Yes - Tooltip text shown on hover
link No - URL for “Learn more” link
link_text No “Learn more” Custom link text
Edit this page
Last updated
Built with Docyard