joplin-plugin-click-to-copy 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,59 @@
1
+ # Joplin Plugin - Click-to-Copy Spans
2
+
3
+ This Joplin plugin allows you to create inline click-to-copy text spans.
4
+
5
+ **Version**: 1.0
6
+
7
+ ## Installation
8
+
9
+ - Open Joplin and navigate to `Preferences > Plugins`
10
+ - Search for `click-to-copy` and click install
11
+ - Restart Joplin
12
+
13
+ ### Uninstall
14
+
15
+ - Open Joplin and navigate to `Tools > Options > Plugins`
16
+ - Search for `Click-to-copy` plugin
17
+ - Press `Delete` to remove the plugin or `Disable` to disable it
18
+ - Restart Joplin
19
+
20
+ ## Usage
21
+
22
+ ### Click-to-copy spans
23
+
24
+ In order to create a collapsible block, you can:
25
+ - press on the `Click-to-Copy Span` toolbar button to create a template span, or
26
+ - highlight text then press on the `Click-to-Copy Span` toolbar button to convert it to a span, or
27
+ - or manually type in the following format:
28
+
29
+ ```
30
+ [[insert text here]]
31
+ ```
32
+
33
+ You can additionally make the text within the span render as inline code by wrapping the entire contents of the span in backticks, like so:
34
+
35
+ ```
36
+ [[`This will render as inline code, but still be click-to-copy`]]
37
+ ```
38
+
39
+ ## Custom styles
40
+
41
+ If you would like to style the collapsible blocks to your preference, use the following in your `userstyle.css` file, which can be accessed in `Joplin` → `Options` → `Appearance` → `Show Advanced Settings` → `Custom stylesheet for rendered Markdown`:
42
+
43
+ ```css
44
+ /* Styling of the click-to-copy spans */
45
+ .ctc {
46
+
47
+ }
48
+ ```
49
+
50
+ ## Settings
51
+ There is a settings page for the plugin in the Joplin options. There, you can customize the start and end tokens away from the default `[[` and `]]`.
52
+
53
+ ## Notes
54
+
55
+ - **There might be bugs**, [report them here](https://github.com/ntczkjfg/joplin-plugin-click-to-copy-span/issues) and I'll try to fix them if I can.
56
+
57
+ ## Acknowledgement
58
+
59
+ Thanks to the creator of the [Joplin Spoilers](https://github.com/martinkorelic/joplin-plugin-spoilers) plugin, whose code helped me build this plugin.
package/package.json ADDED
@@ -0,0 +1,29 @@
1
+ {
2
+ "name": "joplin-plugin-click-to-copy",
3
+ "version": "1.0.0",
4
+ "scripts": {
5
+ "dist": "webpack --env joplin-plugin-config=buildMain && webpack --env joplin-plugin-config=buildExtraScripts && webpack --env joplin-plugin-config=createArchive",
6
+ "prepare": "npm run dist",
7
+ "updateVersion": "webpack --env joplin-plugin-config=updateVersion",
8
+ "update": "npm install -g generator-joplin && yo joplin --node-package-manager npm --update --force"
9
+ },
10
+ "license": "MIT",
11
+ "keywords": [
12
+ "joplin-plugin"
13
+ ],
14
+ "files": [
15
+ "publish"
16
+ ],
17
+ "devDependencies": {
18
+ "@types/node": "^18.7.13",
19
+ "chalk": "^4.1.0",
20
+ "copy-webpack-plugin": "^11.0.0",
21
+ "fs-extra": "^10.1.0",
22
+ "glob": "^8.0.3",
23
+ "tar": "^6.1.11",
24
+ "ts-loader": "^9.3.1",
25
+ "typescript": "^4.8.2",
26
+ "webpack": "^5.74.0",
27
+ "webpack-cli": "^4.10.0"
28
+ }
29
+ }
@@ -0,0 +1,21 @@
1
+ {
2
+ "manifest_version": 1,
3
+ "id": "com.joplin.click.to.copy",
4
+ "app_min_version": "3.2",
5
+ "version": "1.0.0",
6
+ "name": "Click to copy",
7
+ "description": "Create text spans which are click-to-copy.",
8
+ "author": "ntczkjfg",
9
+ "homepage_url": "https://github.com/ntczkjfg/joplin-plugin-click-to-copy-span",
10
+ "repository_url": "https://github.com/ntczkjfg/joplin-plugin-click-to-copy-span",
11
+ "keywords": [
12
+ "joplin",
13
+ "plugin",
14
+ "click",
15
+ "copy",
16
+ "spans",
17
+ "click-to-copy"
18
+ ],
19
+ "_publish_hash": "sha256:f6d6e8698f29eb699e96aa4f5749e1ccff882df5d6bd3332e669e8f21f139d86",
20
+ "_publish_commit": "master:9707f56edf424924af2cb540ade8ecfdf042dbaf"
21
+ }