https://github.com/ambrt/joplin-plugin-create-note-from-text

https://github.com/ambrt/joplin-plugin-create-note-from-text

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/ambrt/joplin-plugin-create-note-from-text
• Owner: ambrt
• Created: 2020-12-05T14:03:00.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-25T23:54:28.000Z (almost 2 years ago)
• Last Synced: 2024-08-02T02:02:31.119Z (4 months ago)
• Language: TypeScript
• Size: 217 KB
• Stars: 21
• Watchers: 2
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-joplin - Create note from highlighted text - note-from-highlighted-text/12511) [**Experimental**] Turns text or block of text into new note under active folder. (Plugins / Old-Style Plugins)

README

        
# Details

https://discourse.joplinapp.org/t/create-note-from-highlighted-text/12511

# Joplin Plugin

This is a template to create a new Joplin plugin.

The main two files you will want to look at are:

- `/src/index.ts`, which contains the entry point for the plugin source code.

- `/src/manifest.json`, which is the plugin manifest. It contains information such as the plugin a name, version, etc.

## Building the plugin

The plugin is built using Webpack, which creates the compiled code in `/dist`. A JPL archive will also be created at the root, which can use to distribute the plugin.

To build the plugin, simply run `npm run dist`.

The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.

## Updating the plugin framework

To update the plugin framework, run `yo joplin --update`

Keep in mind that doing so will overwrite all the framework-related files **outside of the "src/" directory** (your source code will not be touched). So if you have modified any of the framework-related files, such as package.json or .gitignore, make sure your code is under version control so that you can check the diff and re-apply your changes.

For that reason, it's generally best not to change any of the framework files or to do so in a way that minimises the number of changes. For example, if you want to modify the Webpack config, create a new separate JavaScript file and include it in webpack.config.js. That way, when you update, you only have to restore the line that include your file.