From a14674aaa850dab65e44a6a99e223a5895048f79 Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Fri, 25 Aug 2023 10:41:27 +0100 Subject: [PATCH] Doc: Update plugin generator doc --- packages/generator-joplin/README.md | 8 +++++++- .../generators/app/templates/GENERATOR_DOC.md | 9 ++------- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/packages/generator-joplin/README.md b/packages/generator-joplin/README.md index f633fdc56..f5c297aa3 100644 --- a/packages/generator-joplin/README.md +++ b/packages/generator-joplin/README.md @@ -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 diff --git a/packages/generator-joplin/generators/app/templates/GENERATOR_DOC.md b/packages/generator-joplin/generators/app/templates/GENERATOR_DOC.md index 8f418f1ee..b170e3572 100644 --- a/packages/generator-joplin/generators/app/templates/GENERATOR_DOC.md +++ b/packages/generator-joplin/generators/app/templates/GENERATOR_DOC.md @@ -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: