markusmo3_obsidian-private-.../README.md
2025-03-14 16:15:50 +01:00

2.4 KiB
Raw Permalink Blame History

Private Mode

Simple #private mode for Obsidian. All files, links and search results tagged with #private will get a blurred out in the default mode. You have to either hover over or focus on the element to show it temporarily or use the command "Reveal all" to always show it.

This plugin requires the obsidian plugin Supercharged Links to work

docs/img.png

docs/img_1.png

Features

  • 3 Three Modes
    • Reveal all: to disable the blurring completely
    • Reveal on hover: only show #private content on hover (default)
    • Reveal never: only show #private content for the currently editing line
  • 💻 By default not visible when using screenshare! Keep your secrets :)
  • 📱 Supported on Obsidian Mobile
  • 🎀 Commands to set visibility (also usable on mobile)
  • Status bar indicator that shows the current state
    • left click to cycle visibility
    • right click to open the menu
    • red means recording and obsidian will be visible in screensharing
  • ⌨️ Keyboard shortcuts
    • ALT-L cycles visibility
    • ALT-SHIFT-L cycles screen share protection
  • 💬 Callout private, which is also blurred and can be collapsed via default Obsidian behaviour for even more "hidden-ness"
    > [!private]- Optional Title
    > some text here:
    > - list
    

Installing

The plugin is not available on the community page, as its mostly for me personally, so to install it:

  1. Install Supercharged Links via the Settings Panel "Community Plugins"
  2. Go into your Obsidian Vaults plugin folder .obsidian/plugins
  3. Copy the files from the latest release in there
  4. (Optional) Adjust the styles.scss/styles.css to your liking
    • to compile the scss you can use sass npm install -g sass and sass styles.scss styles.css
  5. Enable the plugin in your Obsidian in the Settings panel "Community Plugins"

Credits

Huge thanks to Privacy Glasses for the groundwork and being licensed under MIT. Use that plugin if you want a more in depth configuration. I personally didn't need or want that much customization and overhead in my plugin. Also i found the "flickering" when opening any file to be too distracting, so i created a simpler version for myself.