self-hosted/joplin
1
0
Fork 0
mirror of https://github.com/laurent22/joplin.git synced 2025-01-02 12:47:41 +02:00
Code Issues Releases Activity

Doc: Update plugin generator doc

Browse Source
This commit is contained in:
Laurent Cozic 2023-08-25 10:41:27 +01:00
parent a03401a692
commit a14674aaa8
2 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
packages/generator-joplin/README.md
View File

@ -2,7 +2,13 @@
This is the Yeoman generator used to create a Joplin plugin.
More info in the [Plugin Generator Doc](./generators/app/templates/GENERATOR_DOC.md)
## Development
To test the generator itself for development purposes, follow the instructions there: https://yeoman.io/authoring/#running-the-generator
## More info
For the user-side documentation, see the [Plugin Generator Doc](./generators/app/templates/GENERATOR_DOC.md)
## License

9
packages/generator-joplin/generators/app/templates/GENERATOR_DOC.md
View File

@ -1,6 +1,6 @@
# generator-joplin
# Plugin development
Scaffolds out a new Joplin plugin
This documentation describes how to create a plugin, and how to work with the plugin builder framework and API.
## Installation
@ -17,11 +17,6 @@ Then generate your new project:
yo --node-package-manager npm joplin
```
## Development
To test the generator for development purposes, follow the instructions there: https://yeoman.io/authoring/#running-the-generator
This is a template to create a new Joplin plugin.
## Structure
The main two files you will want to look at are: