obsidian-plugin/felvesthe_Note-Locker
1
0
Fork 0
mirror of https://github.com/felvesthe/Note-Locker.git synced 2026-07-22 05:44:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
85 commits 2 branches 6 tags 186 KiB
TypeScript 94.9%
JavaScript 5.1%
Find a file
Felvesthe 2dd1faa084 Bump version to 1.2.0 
Signed-off-by: Felvesthe <23108389+Felvesthe@users.noreply.github.com>
2025-05-11 01:39:28 +02:00
.github/workflows Add release workflow 2025-03-24 20:28:32 +01:00
src Add setting for note lock/unlock notifications 2025-05-11 01:38:32 +02:00
.editorconfig use LF instead of CRLF (#28) 2022-04-15 14:13:31 -04:00
.eslintignore fix .eslintignore (#48) 2023-01-19 10:06:51 -05:00
.eslintrc add version bump script (#10) 2022-01-22 16:13:50 -05:00
.gitignore Update .gitignore (#25) 2022-01-28 10:34:53 -05:00
.npmrc add version bump script (#10) 2022-01-22 16:13:50 -05:00
esbuild.config.mjs Code refactor and new features 2025-05-09 15:23:00 +02:00
LICENSE Initial commit 2025-03-24 20:12:32 +01:00
manifest.json Bump version to 1.2.0 2025-05-11 01:39:28 +02:00
package-lock.json Code refactor and new features 2025-05-09 15:23:00 +02:00
package.json Bump version to 1.2.0 2025-05-11 01:39:28 +02:00
README.md Initial version of README 2025-03-24 20:52:52 +01:00
tsconfig.json Code refactor and new features 2025-05-09 15:23:00 +02:00
version-bump.mjs add version bump script (#10) 2022-01-22 16:13:50 -05:00
versions.json Update for 0.15 2022-08-09 13:38:50 -04:00

README.md

🔒 Note Locker

Prevent accidental edits by locking notes in preview mode

✨ Features

  • One-click locking - Toggle notes between editable and locked states
  • Persistent locks - Remembers locked notes between sessions
  • Smart rename handling - Maintains locks when files are renamed
  • Cross-platform - Works on both desktop and mobile
  • Visual feedback - Clear notifications when locking/unlocking

⚙️ Installation

Recommended Method

  1. Open Obsidian Settings → Community plugins
  2. Click "Browse" and search for "Note Locker"
  3. Install and enable the plugin

Not in Community plugins yet? Check manual installation guide below

Manual Installation

  1. Download the latest release from GitHub
  2. Extract to your vault's plugins folder:
    VaultFolder/.obsidian/plugins/note-locker/
  3. Reload Obsidian and enable the plugin

🖱️ Usage

To lock/unlock a note:

  1. Right-click on a note in the file explorer
  2. Select "Lock" or "Unlock" from the context menu

Or:

  1. Open a note
  2. Right-click in the editor
  3. Select "Lock" or "Unlock" from the menu

❓ FAQ

1. Can I edit a locked note?
The lock is designed to prevent accidental edits, not block access completely.

  • Manual override: You can still switch to edit mode if needed
  • Auto-relock: Returns to preview mode when reopening the note
  • Best for: Protecting finalized notes while allowing intentional edits

2. Do locks persist after restarting Obsidian?
Yes, locked notes will remain locked.

3. What happens if I rename a locked note?
The lock will automatically transfer to the new filename.

🐛 Troubleshooting

If locks aren't working properly:

  1. Check for conflicts with other plugins
  2. Ensure you're running the latest version of Obsidian
  3. Try reinstalling the plugin