|
1 | | -# Obsidian Sample Plugin |
2 | | - |
3 | | -This is a sample plugin for Obsidian (https://obsidian.md). |
4 | | - |
5 | | -This project uses TypeScript to provide type checking and documentation. |
6 | | -The repo depends on the latest plugin API (obsidian.d.ts) in TypeScript Definition format, which contains TSDoc comments describing what it does. |
7 | | - |
8 | | -This sample plugin demonstrates some of the basic functionality the plugin API can do. |
9 | | -- Adds a ribbon icon, which shows a Notice when clicked. |
10 | | -- Adds a command "Open Sample Modal" which opens a Modal. |
11 | | -- Adds a plugin setting tab to the settings page. |
12 | | -- Registers a global click event and output 'click' to the console. |
13 | | -- Registers a global interval which logs 'setInterval' to the console. |
14 | | - |
15 | | -## First time developing plugins? |
16 | | - |
17 | | -Quick starting guide for new plugin devs: |
18 | | - |
19 | | -- Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with. |
20 | | -- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it). |
21 | | -- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder. |
22 | | -- Install NodeJS, then run `npm i` in the command line under your repo folder. |
23 | | -- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`. |
24 | | -- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`. |
25 | | -- Reload Obsidian to load the new version of your plugin. |
26 | | -- Enable plugin in settings window. |
27 | | -- For updates to the Obsidian API run `npm update` in the command line under your repo folder. |
28 | | - |
29 | | -## Releasing new releases |
30 | | - |
31 | | -- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release. |
32 | | -- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible. |
33 | | -- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases |
34 | | -- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release. |
35 | | -- Publish the release. |
36 | | - |
37 | | -> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`. |
38 | | -> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json` |
39 | | -
|
40 | | -## Adding your plugin to the community plugin list |
41 | | - |
42 | | -- Check the [plugin guidelines](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines). |
43 | | -- Publish an initial version. |
44 | | -- Make sure you have a `README.md` file in the root of your repo. |
45 | | -- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin. |
46 | | - |
47 | | -## How to use |
48 | | - |
49 | | -- Clone this repo. |
50 | | -- Make sure your NodeJS is at least v16 (`node --version`). |
51 | | -- `npm i` or `yarn` to install dependencies. |
52 | | -- `npm run dev` to start compilation in watch mode. |
53 | | - |
54 | | -## Manually installing the plugin |
55 | | - |
56 | | -- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`. |
57 | | - |
58 | | -## Improve code quality with eslint (optional) |
59 | | -- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code. |
60 | | -- To use eslint with this project, make sure to install eslint from terminal: |
61 | | - - `npm install -g eslint` |
62 | | -- To use eslint to analyze this project use this command: |
63 | | - - `eslint main.ts` |
64 | | - - eslint will then create a report with suggestions for code improvement by file and line number. |
65 | | -- If your source code is in a folder, such as `src`, you can use eslint with this command to analyze all files in that folder: |
66 | | - - `eslint .\src\` |
67 | | - |
68 | | -## Funding URL |
69 | | - |
70 | | -You can include funding URLs where people who use your plugin can financially support it. |
71 | | - |
72 | | -The simple way is to set the `fundingUrl` field to your link in your `manifest.json` file: |
73 | | - |
74 | | -```json |
75 | | -{ |
76 | | - "fundingUrl": "https://buymeacoffee.com" |
77 | | -} |
78 | | -``` |
79 | | - |
80 | | -If you have multiple URLs, you can also do: |
81 | | - |
82 | | -```json |
83 | | -{ |
84 | | - "fundingUrl": { |
85 | | - "Buy Me a Coffee": "https://buymeacoffee.com", |
86 | | - "GitHub Sponsor": "https://github.com/sponsors", |
87 | | - "Patreon": "https://www.patreon.com/" |
88 | | - } |
89 | | -} |
90 | | -``` |
91 | | - |
92 | | -## API Documentation |
93 | | - |
94 | | -See https://github.com/obsidianmd/obsidian-api |
| 1 | +# 🔒 Note Locker |
| 2 | + |
| 3 | +_Prevent accidental edits by locking notes in preview mode_ |
| 4 | + |
| 5 | +## ✨ Features |
| 6 | +- **One-click locking** - Toggle notes between editable and locked states |
| 7 | +- **Persistent locks** - Remembers locked notes between sessions |
| 8 | +- **Smart rename handling** - Maintains locks when files are renamed |
| 9 | +- **Cross-platform** - Works on both desktop and mobile |
| 10 | +- **Visual feedback** - Clear notifications when locking/unlocking |
| 11 | + |
| 12 | +## ⚙️ Installation |
| 13 | +### Recommended Method |
| 14 | +1. Open Obsidian Settings → Community plugins |
| 15 | +2. Click "Browse" and search for "Note Locker" |
| 16 | +3. Install and enable the plugin |
| 17 | + |
| 18 | +Not in Community plugins yet? Check manual installation guide below |
| 19 | + |
| 20 | +### Manual Installation |
| 21 | +1. Download the latest release from GitHub |
| 22 | +2. Extract to your vault's plugins folder: |
| 23 | + `VaultFolder/.obsidian/plugins/note-locker/` |
| 24 | +3. Reload Obsidian and enable the plugin |
| 25 | + |
| 26 | +## 🖱️ Usage |
| 27 | +**To lock/unlock a note:** |
| 28 | +1. Right-click on a note in the file explorer |
| 29 | +2. Select "Lock" or "Unlock" from the context menu |
| 30 | + |
| 31 | +**Or:** |
| 32 | +1. Open a note |
| 33 | +2. Right-click in the editor |
| 34 | +3. Select "Lock" or "Unlock" from the menu |
| 35 | + |
| 36 | +## ❓ FAQ |
| 37 | +**1. Can I edit a locked note?** |
| 38 | +The lock is designed to prevent accidental edits, not block access completely. |
| 39 | +- Manual override: You can still switch to edit mode if needed |
| 40 | +- Auto-relock: Returns to preview mode when reopening the note |
| 41 | +- Best for: Protecting finalized notes while allowing intentional edits |
| 42 | + |
| 43 | +**2. Do locks persist after restarting Obsidian?** |
| 44 | +Yes, locked notes will remain locked. |
| 45 | + |
| 46 | +**3. What happens if I rename a locked note?** |
| 47 | +The lock will automatically transfer to the new filename. |
| 48 | + |
| 49 | +## 🐛 Troubleshooting |
| 50 | +If locks aren't working properly: |
| 51 | +1. Check for conflicts with other plugins |
| 52 | +2. Ensure you're running the latest version of Obsidian |
| 53 | +3. Try reinstalling the plugin |
0 commit comments