Preview Inline Annotation syntax as ruby/furigana, over/under glosses, bouten, overlines, and underlines in VS Code's built-in Markdown preview.
[漢字]^^(かんじ)
[base]^^(over)^_(under)
[重要]^^(..)^_(.~)
The extension is a thin adapter: it installs
markdown-it-inline-annotation
through VS Code's extendMarkdownIt hook.
Scope
| Feature | Support |
|---|---|
| Built-in Markdown preview | yes |
| Source editor decorations | no |
| Hover, diagnostics, completion, code actions | no |
| Preview scripts or external resources | none |
VS Code provides one contiguous Markdown source stream, so rich-text run boundaries do not apply here. Markdown-owned constructs such as escapes, emphasis, strikethrough, links, code, HTML, and entities remain under markdown-it's rules.
Development
npm install
npm run check
Inside the sibling-repo workspace, verify the adapter against an unpublished core change with:
npm run check:local
The test suite runs the shared renderer corpus and the contiguous-source side
of the segment-boundary fixtures. Before publishing, update the lockfile to the
released core version and run the normal npm run check path again.
Ecosystem
- Inline Annotation spec and core
- Inline Ruby Annotation for Obsidian
- Logseq reference plugin
- Original proposal
Safety
The adapter injects no preview scripts. The shared renderer escapes user-authored text before returning HTML to VS Code.
License
MIT