You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: GENERATOR_DOC.md
+15-9Lines changed: 15 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,27 +1,22 @@
1
-
# generator-joplin
1
+
# Plugin development
2
2
3
-
Scaffolds out a new Joplin plugin
3
+
This documentation describes how to create a plugin, and how to work with the plugin builder framework and API.
4
4
5
5
## Installation
6
6
7
7
First, install [Yeoman](http://yeoman.io) and generator-joplin using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
8
8
9
9
```bash
10
-
npm install -g yo
10
+
npm install -g yo@4.3.1
11
11
npm install -g generator-joplin
12
12
```
13
13
14
14
Then generate your new project:
15
15
16
16
```bash
17
-
yo joplin
17
+
yo --node-package-manager npm joplin
18
18
```
19
19
20
-
## Development
21
-
22
-
To test the generator for development purposes, follow the instructions there: https://yeoman.io/authoring/#running-the-generator
23
-
This is a template to create a new Joplin plugin.
24
-
25
20
## Structure
26
21
27
22
The main two files you will want to look at are:
@@ -39,6 +34,10 @@ To build the plugin, simply run `npm run dist`.
39
34
40
35
The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.
41
36
37
+
## Updating the manifest version number
38
+
39
+
You can run `npm run updateVersion` to bump the patch part of the version number, so for example 1.0.3 will become 1.0.4. This script will update both the package.json and manifest.json version numbers so as to keep them in sync.
40
+
42
41
## Publishing the plugin
43
42
44
43
To publish the plugin, add it to npmjs.com by running `npm publish`. Later on, a script will pick up your plugin and add it automatically to the Joplin plugin repository as long as the package satisfies these conditions:
@@ -67,6 +66,13 @@ By default, the compiler (webpack) is going to compile `src/index.ts` only (as w
67
66
68
67
To get such an external script file to compile, you need to add it to the `extraScripts` array in `plugin.config.json`. The path you add should be relative to /src. For example, if you have a file in "/src/webviews/index.ts", the path should be set to "webviews/index.ts". Once compiled, the file will always be named with a .js extension. So you will get "webviews/index.js" in the plugin package, and that's the path you should use to reference the file.
Copy file name to clipboardExpand all lines: README.md
+68-33Lines changed: 68 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,9 @@
1
1
<h1align = "center" > Email Plugin </h1>
2
2
3
-
This plugin adds the ability to fetch email messages (including attachments) and converts them to Joplin notes in various formats, either by monitoring any `new` or `unread` messages from a specific email address or a specific mailbox, or by uploading downloaded email messages to the plugin without having to be logged in.
3
+
This plugin allows you to fetch email messages (including attachments) and convert them into Joplin notes in multiple formats.
4
+
5
+
Emails can be processed automatically by monitoring `new` or `unread` messages from a specific email address or mailbox, or manually by uploading downloaded email messages in `.eml` format without needing to log in to the plugin.
6
+
4
7
5
8
***
6
9
@@ -16,64 +19,96 @@ This plugin adds the ability to fetch email messages (including attachments) and
16
19
17
20
## Features
18
21
19
-
-Monitoring and fetching any `new` or `unread` messages from a specific email address.
22
+
-Monitor and fetch **new or unread emails** from a specific email address.
20
23
21
-
-Monitoring and fetching any `new` or `unread` messages from a specific mailbox.
24
+
-Monitor and fetch **new or unread emails** from a selected mailbox.
22
25
23
-
- Send the converted message to specific notebooks and add tags to the note by using `@` or `#` in the email subject or first line of email content and then forward the email to yourself.
26
+
- You can control how notes are created using simple syntax in the **email subject** or the **first line of the email body**:
27
+
-`@notebook` → save the note to a specific notebook
28
+
-`#tag` → add tags to the note
29
+
-`!Subject` → create a **Todo** note
24
30
25
-
- Convert emails (including attachments) to notes without having to be logged into the plugin.
31
+
- Convert email messages (including attachments) into notes **without being logged into the plugin**.
26
32
27
-
- Convert email messages to notes in different formats (`HTML`, `Markdown`, `Text`).
33
+
- Convert emails into notes using different output formats:
34
+
-`HTML`
35
+
-`Markdown`
36
+
-`Plain Text`
28
37
29
-
- Show attachments in different styles, whether they are in the form of a `Table` or `Links`.
38
+
- Display attachments in multiple styles, such as:
39
+
-`Table`
40
+
-`Links`
30
41
31
42
***
32
43
33
44
## How to use
34
45
35
-
-### Monitoring and fetching from a specific email address
46
+
-### 🔍 Monitoring and Fetching from a Specific Email Address
36
47
37
-
- Open Email Plugin.
48
+
1. Open the **Email Plugin**.
49
+
2. Sign in with your email credentials.
50
+
3. Enter the email account you want to **monitor for new or unread messages**, then enable **Fetching & Monitoring**.
38
51
39
-
- Login to the plugin with your email address and password.
52
+
#### ✉️ Forwarding Emails to Create Notes
53
+
If you enter **your own email address** in the **From** field, you can simply **forward emails to yourself**.
54
+
55
+
You can control how the note is created using the following syntax:
56
+
-**Set note title**
57
+
The email subject is used as the note title.
58
+
59
+
-**Assign to a notebook**
60
+
Add `@notebook-name` to send the note to a specific notebook.
40
61
41
-
- Enter the email account you want to start fetching and monitoring `new` or `unread` messages from and click on the `Fetching & Monitoring` toggle.
62
+
-**Add tags**
63
+
Add `#tag-name` to attach tags to the note.
42
64
43
-
- If you enter your email address in the `from` field, simply forward the email message to yourself after adding some easy syntax to the end of the email subject, or add this syntax in a new line at the beginning of the message content, and the plugin will handle the rest.
65
+
-**Create a Todo note**
66
+
Start the subject with `!` to create a **Todo** instead of a regular note.
44
67
45
-
-**Set a note title** : Change note title by changing the subject of the email.
46
-
-**Add to a notebook** : Add `@notebook` to send it to a specific notebook.
47
-
-**Add tags** : Add `#tag` to organize the note with a tag.
48
68
49
-
> **For example**: Say you want this email located in the **joplin** and **gmail** folders and also want to add **gmail** and **email** as tags to the note. Just edit the email subject or add a new line at the beginning of the message content like this:
50
-
>>Email subject: My message @**joplin** @**email** #**gmail** #**email**
0 commit comments