0
Fork 0
mirror of https://github.com/penpot/penpot.git synced 2025-01-09 00:10:11 -05:00
penpot/docs/user-guide/plugins/index.njk
2024-10-30 13:30:02 +01:00

49 lines
2.8 KiB
Text
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: 17· Plugins
---
<h1 id="penpot-plugins">Penpot Plugins</h1>
<h2 id="plugins">Plugins</h2>
<p class="main-paragraph">Plugins are the perfect tool to extend Penpot's functionalities. You can install available plugins or create one that fits your needs!</p>
<h2 id="installation">How to install Plugins</h2>
<h3 id="hub-installation">From PenpotHub</h2>
<p>You can find available Plugins at the <a href="https://help.penpot.app/plugins/getting-started/#examples">Penpot Hub</a> and install plugins directly from the Plugins page by clicking on <strong>Install</strong> next to the desired plugin.</p>
<img src="/img/plugins/00_PenpotHub_plugins.png" alt="Plugins in the Penpot hub's"></img>
<h3 id="url-installation">With a URL</h3>
<p>Another way to install a plugin is by copying the URL (with .json extension) provided by the plugins author and pasting it on to the Plugin Manager.</p>
<img src="/img/plugins/02_install_url.png" alt="Install plugins using url"></img>
<p class="advice">Please note that you'll need to grant access to your files. Plugins may be created by external parties, so ensure you trust it before granting access. Your data privacy and security are important to us. If you have any concerns, please contact <a href="mailto:support@penpot.app">support</a>.</p>
<p class="advice">If a plugin is later updated by the author and requires new permissions, we will notify you so that you can update it.</p>
<img src="/img/plugins/01_OAuth_permissions.png" alt="Plugin's permissions modal"></img>
<p>Once a plugin has been installed you can access it on your files, as long as you have permissions to access it, in any of your teams. If another member of your team wants to use the plugin, they will need to install it individually.</p>
<h2 id="plugin-manager">Plugin Manager</h2>
<p class="main-paragraph">To start using Plugins you first need to open the Plugin Manager. There are a few different ways to access the Plugins Manager in the Worskpace:</p>
<ul>
<li>From the toolbar;</li>
<li>From the menu;</li>
<li>Using the shortcut <strong>Ctrl + Alt + P</strong>.</li>
</ul>
<h3>Toolbar</h3>
<img src="/img/plugins/03_toolbar_plugins.png" alt="Open plugin manager via toolbar"></img>
<h3>Menu</h3>
<img src="/img/plugins/04_menu_plugins.png" alt="Open plugin manager via menu"></img>
<h2 id="using-plugins">Using plugins</h2>
<p>To use a plugin, go to the Plugin Manager, and click on <strong>Open</strong> next to the desired plugin, and thats it, enjoy!</p>
<img src="/img/plugins/05_plugin_manager.png" alt="Plugin manager modal"></img>
<h2 id="create-plugin">Create a Plugin</h2>
<p>You can create your own plugin from scratch or use a Template to get started. You can find the complete guide to creating Plugins at the <a href="https://help.penpot.app/plugins/create-a-plugin/">Technical Guide</a>.</p>