joplin-plugin-quick-note 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Aravind Potluri
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,74 @@
+# Quick Note Plugin for Joplin
+
+**Quick Note** allows you to instantly open a dedicated note for capturing ideas, tasks, or reminders — either on startup or via a customizable keyboard shortcut (default: ALT+Q).
+
+<div align=center>
+  <p>Capture ideas instantly with a dedicated Quick Note.</p>
+</div>
+
+---
+
+<div align="center">
+  <p>Desktop</p>
+  <img src="docs/assets/desktop.gif" alt="Desktop GIF" style="margin-bottom:20px;" />
+</div>
+
+---
+
+<div align="center">
+  <p>Mobile</p>
+  <img src="docs/assets/mobile.gif" alt="Mobile GIF" height="600px" />
+</div>
+
+## Features
+
+- Open a Quick Note on Joplin startup.
+- Set any note as your Quick Note.
+- Open Quick Note anytime with **Alt+Q** (customizable shortcut).
+- Toolbar button for one-click access.
+- Easily unset the Quick Note when no longer needed.
+
+## Installation
+
+There are two ways to install Quick Note:
+
+1. **Via Joplin Plugin Search:**
+
+   - Open Joplin → Tools → Options → Plugins → `Search`.
+   - Search for **Quick Note** and install directly.
+
+2. **Manual Installation:**
+
+   - Follow the instructions in [GENERATOR_DOC](GENERATOR_DOC.md) to generate the `.jpl` file.
+   - Open Joplin → Tools → Options → Plugins → `Install from file`.
+   - Select the generated `.jpl` file and install.
+
+## Usage
+
+1. Select a note → **Tools → Quick Note → Set as Quick Note**.
+2. Quick Note automatically opens on Joplin startup (can be disabled in settings).
+3. Press **Alt+Q** (or your configured shortcut) to open the Quick Note instantly.
+4. To unset the Quick Note, use **Unset Quick Note** from the menu.
+
+## Settings
+
+Navigate to **Tools → Options → Quick Note** to configure:
+
+| Setting             | Description                                           |
+| ------------------- | ----------------------------------------------------- |
+| **Open on Startup** | Automatically open the Quick Note when Joplin starts. |
+| **Quick Note ID**   | The ID of the note set as Quick Note.                 |
+
+## Commands
+
+- **Open Quick Note** → Opens your Quick Note.
+- **Set as Quick Note** → Sets the current note as your Quick Note.
+- **Unset Quick Note** → Removes the Quick Note.
+
+## Contributing
+
+Contributions are welcome! Feel free to open issues or pull requests on [GitHub](https://github.com/cipherswami/joplin-plugin-quick-note).
+
+## License
+
+[MIT License © Aravind Potluri](./LICENSE)

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "joplin-plugin-quick-note",
+  "version": "1.0.0",
+  "scripts": {
+    "dist": "webpack --env joplin-plugin-config=buildMain && webpack --env joplin-plugin-config=buildExtraScripts && webpack --env joplin-plugin-config=createArchive",
+    "prepare": "npm run dist",
+    "updateVersion": "webpack --env joplin-plugin-config=updateVersion",
+    "update": "npm install -g generator-joplin && yo joplin --node-package-manager npm --update --force"
+  },
+  "license": "MIT",
+  "keywords": [
+    "joplin-plugin",
+    "quick note"
+  ],
+  "files": [
+    "publish"
+  ],
+  "devDependencies": {
+    "@types/node": "^18.7.13",
+    "chalk": "^4.1.0",
+    "copy-webpack-plugin": "^11.0.0",
+    "fs-extra": "^10.1.0",
+    "glob": "^8.0.3",
+    "tar": "^6.1.11",
+    "ts-loader": "^9.3.1",
+    "typescript": "^4.8.2",
+    "webpack": "^5.74.0",
+    "webpack-cli": "^4.10.0"
+  }
+}

package/publish/com.cipherswami.quick.note.json

@@ -0,0 +1,56 @@
+{
+	"manifest_version": 1,
+	"id": "com.cipherswami.quick.note",
+	"app_min_version": "3.3",
+	"version": "1.0.0",
+	"name": "Quick Note",
+	"description": "Quickly jot down notes on startup or with a shortcut.",
+	"author": "Aravind Potluri",
+	"homepage_url": "https://cipherswami.github.io/joplin-plugin-quick-note",
+	"repository_url": "https://github.com/cipherswami/joplin-plugin-quick-note",
+	"platforms": [
+		"desktop",
+		"mobile"
+	],
+	"keywords": [
+		"joplin-plugin",
+		"quick note"
+	],
+	"categories": [
+		"productivity"
+	],
+	"screenshots": [
+		{
+			"src": "docs/assets/quick-note.png",
+			"label": "Quick Note"
+		},
+		{
+			"src": "docs/assets/desktop-main.png",
+			"label": "Desktop main"
+		},
+		{
+			"src": "docs/assets/desktop-settings.png",
+			"label": "Desktop settings"
+		},
+		{
+			"src": "docs/assets/mobile-main.png",
+			"label": "Mobile main"
+		},
+		{
+			"src": "docs/assets/mobile-settings.png",
+			"label": "Mobile settings"
+		}
+	],
+	"icons": {
+		"16": "docs/assets/icon-16.png",
+		"32": "docs/assets/icon-32.png",
+		"128": "docs/assets/icon-128.png",
+		"512": "docs/assets/icon-512.png"
+	},
+	"promo_tile": {
+		"src": "docs/assets/quick-note-promo.png",
+		"label": "Quick Note"
+	},
+	"_publish_hash": "sha256:1c3d6f29668b184616071a30457bb7ea5e564c403def43b632fcb260f2c6140e",
+	"_publish_commit": "main:60eb9d9d1e490d9f6ed1d3536bb7fa586735324a"
+}