-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
6 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,11 @@ | ||
# Joplin Plugin | ||
# Quick Links Plugin for Joplin | ||
|
||
This is a template to create a new Joplin plugin. | ||
This Plugin for the note taking app [Joplin](https://joplinapp.org/) gives you a quicker way to add Links to other notes. | ||
|
||
The main two files you will want to look at are: | ||
## How to use | ||
|
||
- `/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. | ||
Type `@@` anywhere in your note and select the note to link in the drop down menu. | ||
|
||
## Building the plugin | ||
## How to install | ||
|
||
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 `npm run update`. | ||
|
||
In general this command tries to do the right thing - in particular it's going to merge the changes in package.json and .gitignore instead of overwriting. It will also leave "/src" as well as README.md untouched. | ||
|
||
The file that may cause problem is "webpack.config.js" because it's going to be overwritten. For that reason, if you want to change it, consider creating a 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. | ||
TBD |