https://github.com/der-tobi/obsidian-simple-mention

Obsidian plugin for mentioning people
https://github.com/der-tobi/obsidian-simple-mention

mention mentions obsidian-md obsidian-plugin

Last synced: 3 months ago
JSON representation

Obsidian plugin for mentioning people

• Host: GitHub
• URL: https://github.com/der-tobi/obsidian-simple-mention
• Owner: der-tobi
• License: gpl-3.0
• Created: 2022-03-22T20:40:35.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-26T13:12:54.000Z (12 months ago)
• Last Synced: 2024-06-17T22:42:37.454Z (5 months ago)
• Topics: mention, mentions, obsidian-md, obsidian-plugin
• Language: TypeScript
• Homepage:
• Size: 1.07 MB
• Stars: 34
• Watchers: 6
• Forks: 5
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - der-tobi/obsidian-simple-mention - Obsidian plugin for mentioning people (TypeScript)

README

        
# Obsidian simple mention

A simple plugin that visually highlights mentions and suggests existing ones as you write (except in codeblocks).   

The mention prefix can be customized and defaults to `@`.  

Find all occurrences of a mention in the side pane and jump to the corresponding line in the document.  

Distinguish your personal mentions from the others by a different color.

![Overview obsidian simple mention](obsidian_general.gif)

Filter your mentions by a phrase

![Filter your mentions](obsidian_filter.gif)

## Settings

You can:

- set the trigger phrase (@)

- set the color of the mentions (green)

- set the color of your own mentions (deeppink)

- set the name, how you want to mention yourself (Me)

- delete the cache (indexeddb)

## Shortcuts

### In edit mode

`ctrl+space` or `ctrl+click` on a mention, opens the right side pane with all occurrences of that mention.

![Edit mode shortcuts (ctrl+space or ctrl+click)](obsidian_ctrl_space.gif)

### In preview mode

When you click on a mention, the right side pane opens with all occurrences of that mention.

![Preview Mode shortcuts](obsidian_preview_klick.gif)

## Known issues

- We need to restart Obsidian after

  - adjusting the trigger phrase for the changes to take effect.

  - changing the name of yourself for the changes to take effect.

  - ignoring a directory

  - deleting the cache

- Style could currently not be overridden by a template (simple fix)

## Ideas

- Group mentions

  - eg. @group-x(@bob,@lisa)

  - usage: find all mentions of @bob and @lisa by searching for @group-x

- Multi select of mentions in the view

- Show sub bullet points

- own color for each "person"