Overview

Abbreviations refer to short forms used in Markdown, such as technical terms like W3C and ECMA.

When hovering over an abbreviation, the full term will be displayed along with its definition or explanation.

Configuration

This feature is disabled by default. Enable it in theme configuration:

.vuepress/config.ts

export default defineUserConfig({
  theme: plumeTheme({
    markdown: {
      abbr: true, 
    }
  })
})

Syntax

In Markdown, define abbreviations using *[ABBR]: Description on separate lines. The description may include the abbreviation's definition, explanation, etc.

Place the abbreviation within [] and its description after :. The description supports Markdown inline syntax.

If the Markdown plain text contains defined abbreviations, the explanation of the abbreviation will be automatically displayed when the mouse moves over it.

Input:

The HTML specification is maintained by the W3C.

*[HTML]: Hyper Text Markup Language
*[W3C]:  World Wide Web Consortium

Output:

The HTML specification is maintained by the W3C.

Abbreviations should be standalone words or phrases. For Chinese abbreviations, add spaces around the term to ensure proper detection.

Contributors

zhenghaoyang24pengzhanbo

Changelog

3/27/25, 1:06 PM

View All Changelog

• 9f99a-docs: add en markdown doc (#538)on 3/27/25