Penpot/penpot-plugins
0
Fork 0
mirror of https://github.com/penpot/penpot-plugins.git synced 2025-01-04 13:50:13 -05:00
Code Issues Activity

feat(api-doc): update readme

Browse source
This commit is contained in:
María Valderrama 2024-09-17 14:36:01 +02:00
parent 2909bcceb6
commit 99ff81d42c
1 changed files with 11 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
libs/plugin-types/README.md
View file

@ -1,16 +1,20 @@
# Penpot plugin-types
This repository contains the typings for the Penpot Plugin API.
The `@penpot/plugin-types` package provides TypeScript type definitions for the Penpot Plugin API, making it easier to develop plugins for the Penpot design platform with full type safety and IDE support. It streamlines the development process by ensuring that your code is well-typed and less prone to errors.
### Getting started
Install the package:
#### Installation
To add penpot's plugin-types to your project, use the following command:
```bash
npm install @penpot/plugin-types
```
Configure `tsconfig.json`
#### Configuration
To ensure the typings work correctly in your project, update your tsconfig.json as follows:
```json
"typeRoots": [
@ -19,3 +23,7 @@ Configure `tsconfig.json`
],
"types": ["plugin-types"],
```
### Learn more
For more information on how to build plugins using the Penpot PLugin API, refer to the <a href="https://penpot-docs-plugins.pages.dev/plugins/getting-started/" target="_blank">official documentation</a>. You can also explore practical examples in the <a href="https://github.com/penpot/penpot-plugins-samples" target="_blank">samples repository</a> to see real-world implementations.