docs: add notes to CLI

ueberdosis · Feb 26, 2023 · d79a7c9 · d79a7c9
1 parent 8b65dff
commit d79a7c9
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/docs/api/extensions.md b/docs/api/extensions.md
@@ -63,4 +63,10 @@ const editor = new Editor({
 })
 ```
 
+You can easily bootstrap a new extension via our CLI.
+
+```bash
+npm init tiptap-extension
+```
+
 Learn [more about custom extensions in our guide](/guide/custom-extensions).
diff --git a/docs/guide/custom-extensions.md b/docs/guide/custom-extensions.md
@@ -649,5 +649,12 @@ const CustomExtension = Extension.create({
 })
 ```
 
+## Creating and publishing standalone extensions
+
+If you want to create and publish your own extensions for Tiptap, you can use our CLI tool to bootstrap your project.
+Simply run `npm init tiptap-extension` and follow the instructions. The CLI will create a new folder with a pre-configured project for you including a build script running on rollup.
+
+If you want to test your extension locally, you can run `npm link` in the project folder and then `npm link YOUR_EXTENSION` in your project (for example a vite app).
+
 ## Sharing
 When everything is working fine, don’t forget to [share it with the community](https://github.com/ueberdosis/tiptap/issues/819).