https://github.com/chern-kp/obsidian-tooltips-in-vscode

Allows to link Obsidian notes with keywords in code and to display note link or content in tooltip
https://github.com/chern-kp/obsidian-tooltips-in-vscode

obsidian obsidian-md visual-studio-code visual-studio-code-extension

Last synced: about 5 hours ago
JSON representation

Allows to link Obsidian notes with keywords in code and to display note link or content in tooltip

• Host: GitHub
• URL: https://github.com/chern-kp/obsidian-tooltips-in-vscode
• Owner: chern-kp
• License: mit
• Created: 2025-01-10T17:57:51.000Z (25 days ago)
• Default Branch: master
• Last Pushed: 2025-02-02T21:02:19.000Z (2 days ago)
• Last Synced: 2025-02-02T22:18:12.507Z (2 days ago)
• Topics: obsidian, obsidian-md, visual-studio-code, visual-studio-code-extension
• Language: JavaScript
• Homepage:
• Size: 97.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Obsidian Tooltips in VS Code

**Obsidian Tooltips in VS Code** is an extension for Visual Studio Code that adds hover popups (tooltips) over keywords that match note parameters (such as names and aliases) from your specified Obsidian (Obsidian MD) vault. These tooltips contain links to the corresponding Obsidian notes and can display either full or partial content of the note (customizable by the user).

In development.

## Use Case

You can use this extension to connect to the Obsidian vault that you use as your personal programming reference. This allows you to see tooltips with your own documentation and explanations when you hover over terms you've previously documented in Obsidian.

## Features

- Choose and connect to your Obsidian vault

- Display note content in tooltip after hovering over text matching note titles or aliases from your Obsidian vault

  - Full support for Obsidian note aliases defined in YAML frontmatter

- Choose specific directories within your vault to include in the search scope

- Setting to underline matched keywords

## Requirements

- Visual Studio Code 1.60.0 or higher

- Obsidian installed on your system

- An existing Obsidian vault, filled with notes with titles or aliases corresponding to words you will find while code editing (keyword of programming language etc)

## Extension Settings

This extension contributes the following settings:

* `obsidian-tooltips.enableExternalLinks`: Enable/disable opening Obsidian links from tooltips (Default: Enabled)

* `obsidian-tooltips.enableWordUnderline`: Enable/disable underlining of matched keywords that correspond to your Obsidian notes (Default: Disabled)

## Known Issues

## Release Notes

### 1.0.0