3pp-mirror/penpot
1
0
Fork 0
mirror of https://github.com/penpot/penpot.git synced 2025-05-04 17:55:53 +02:00
Code Issues Projects Releases Packages Wiki Activity

📚 Minor fix to plugin docs

Browse source
This commit is contained in:
Belén Albeza 2024-11-28 10:53:04 +01:00
parent c2649ffd1c
commit 4b422ef459
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docs/plugins/create-a-plugin.md
View file

@ -60,10 +60,10 @@ npm install @penpot/plugin-types
If you're using typescript, don't forget to add <code class="language-js">@penpot/plugin-types</code> to your typings in your <code class="language-js">tsconfig.json</code>. If you're using typescript, don't forget to add <code class="language-js">@penpot/plugin-types</code> to your typings in your <code class="language-js">tsconfig.json</code>.
```json ```js
{ {
"compilerOptions": { "compilerOptions": {
[...] // ...
"typeRoots": ["./node_modules/@types", "./node_modules/@penpot"], "typeRoots": ["./node_modules/@types", "./node_modules/@penpot"],
"types": ["plugin-types"], "types": ["plugin-types"],
} }
@ -148,7 +148,7 @@ If you're using Vite you can simply edit the configuration file and add the buil
```ts ```ts
export default defineConfig({ export default defineConfig({
[...] // ...
build: { build: {
rollupOptions: { rollupOptions: {
input: { input: {
@ -168,11 +168,12 @@ export default defineConfig({
And then add the following scripts to your <code class="language-js">package.json</code>: And then add the following scripts to your <code class="language-js">package.json</code>:
```json ```js
"scripts": { "scripts": {
"dev": "vite build --watch & vite preview", "dev": "vite dev",
"build": "tsc && vite build", "build": "tsc && vite build",
[...] "preview": "npm run build && vite preview",
// ...
} }
``` ```
@ -190,11 +191,11 @@ esbuild your-folder/plugin.ts --minify --outfile=your-folder/public/plugin.js
You can add it to your <code class="language-js">package.json</code> scripts so you don't need to manually re-run the build: You can add it to your <code class="language-js">package.json</code> scripts so you don't need to manually re-run the build:
```json ```js
"scripts": { "scripts": {
"start": "npm run build:plugin && ng serve", "start": "npm run build:plugin && ng serve",
"build:plugin": "esbuild your-folder/plugin.ts --minify --outfile=your-folder/public/plugin.js" "build:plugin": "esbuild your-folder/plugin.ts --minify --outfile=your-folder/public/plugin.js"
[...] // ...
}, },
``` ```