Collaborate at Github →
+Collaborate at Github →
Penpot is open source. Get involved on the community or contribute to the project.
diff --git a/contributing-guide/index.njk b/contributing-guide/index.njk index e053cfb..0df3d13 100644 --- a/contributing-guide/index.njk +++ b/contributing-guide/index.njk @@ -16,31 +16,31 @@ eleventyNavigation:
Easy steps to bug hunting
How to become a Penpot translator
Help Penpot improve its code
Rules, values and principles
Share your libraries and templates or download the ones you like.
Bug hunting is not difficult if you know how.
-We are using GitHub Issues for our public bugs. We keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn't already exist.
diff --git a/contributing-guide/translations/index.njk b/contributing-guide/translations/index.njk index 8d3d0c3..2d5bfae 100644 --- a/contributing-guide/translations/index.njk +++ b/contributing-guide/translations/index.njk @@ -6,7 +6,7 @@ title: 02· TranslationsThank you for interest in contribute translating Penpot. Here you will find ways to do it.
-We are using Weblate as translation platform, so the first thing you need to be a Penpot translator is to have a Weblate account (you can register here).
To start translating at Penpot:
To add a language that is still not among the Penpot language options:
To add a new translation (a string with a lacking translation for a certain language) follow the next steps:
To edit an already approved translation string follow the next steps:
Everything you need to know about how Penpot works.
How to report bugs, add translations and more.
Installation, configuration and architecture.
Get quick answers to usual questions about "why and how" Penpot.
Penpot is open source. Get involved on the community or contribute to the project.
All component copies used in a file are linked in a way that updates made to the Main component can reflect in their component copies. You can override properties for component copies, so that you can manage singularities while maintaining properties in common.
-You can duplicate a component the same way you can duplicate any other layer. When duplicating a component, you are creating a component copy that will be linked to its main component.
-You can duplicate a component as a new main component from the assets sidebar. Just select the component at the library, open the menu with right click and select the option "Duplicate main".
You can delete main components and its copies anytime the same way you can delete any other layer.
Deleting a main component at the viewport means deleting it at the assets library and viceversa, so be careful!
If a main component has been deleted and you have access to a copy of it, you can use the copy to restore its main. There are two ways to do it:
At the Components section from the Assets library, there are two ways to create groups in a components library.
You can ungroup the components the same ways you can group them, via the menu option ("Ungroup" in this case) or renaming them.
-One very direct way to move components between groups at the assets library is by dragging them.
Where's my component? There are ways to find some components at the assets panel and at the design viewport.
-Select a main component at the viewport and then press "Show in assets panel" at the options of the right sidebar.
Select a component copy and then press "Show main component" at the viewport menu or the right sidebar menu.
You can push changes made at a component copy to a main component:
Main components represent the more generic information of an element in a design system. You will usually need to change specific things (like a text, a color or an icon) in a component while maintaining the inheritance of the rest of it properties. Component overrides allows you to do that in Penpot.
Overrides are modifications made in a specific copy that are not in its main component. With overrides you can keep changes at the component copies while maintaining synchronization with the Main component.
Right click and select the option “Reset overrides” at the component menu to get it to the state of the Main component.
Detach a component copy to unlink it from its Main component and transform it into a group layer. Press Ctrl + Shift + K or right click and select the option “Detach instance” at the component menu.
You can also detach components in bulk by selecting several components and performing the same action.
-Penpot allows you to easily substitute component copies with other component copies.
You can add text annotations to main components. The annotations are shown in every component copy. It is extremely useful to attach specifications that can be read at each component copy.
If you find a page at a file called "Main components" this will probably mean that the file had assets with the previous components system and has been migrated to the current components system. The previous system didn't have the components as layers at the design file, only at the assets library, so when migrating a file to the new version Penpot automatically creates a page where to place all the components, grouping them using the library groups structure.
If you have purchased, personal or libre fonts that are not included in the catalog provided by Penpot, you can upload them from your computer and use them across the files of a team.
-
To use a font that you have on your local machine, first you need to upload it to the Penpot team where you want to use it.
You can find the “Fonts” section in the dashboard menu, at the left sidebar.
-Fonts with the same font family name will be grouped as a single font family. That means that at the font list that you will use at the files they will be shown as only one font with different variants available.
If you want to add a font variant (eg: Light) to a font family (eg: Helvetica) you only need to ensure during the upload process that it has the same font family name.
-At the right side of a font family of the custom fonts list you can find a menu that allows you to edit the name of a font family and delete it.
-Custom fonts are added to the fonts catalog of a team and can be used at the workspace from the font list at the design sidebar.
You should only upload fonts you own or have license to use in Penpot. Find out more in the Content rights section of Penpot's Terms of Service. You also might want to read about font licensing.
diff --git a/user-guide/exporting/index.njk b/user-guide/exporting/index.njk index e5f89ee..5c4df75 100644 --- a/user-guide/exporting/index.njk +++ b/user-guide/exporting/index.njk @@ -5,10 +5,10 @@ title: 07· Exporting objectsIn Penpot you can setup export presets for different file formats and scales.
-You can set up different export configurations to suit your needs. Each export configuration is called "export preset".
-To export an object you need to select it and at the Design panel add an export preset pressing the “+” button of the Export section.
Export presets can be also found at the View mode with the code tab activated.
You can set as many export presets as you need for the same object. Set multiple exports to get the same object in different scales and/or formats with just one click.
-To remove an export preset you have to select the object and then press the “-” button at the export preset you want to remove.
-The options of an export:
To export multiple elements you first have to select the elements you'd like to export. If the selected elements already have export settings those will be included in the export. You can also add new export settings for multiselections.
Before confirming your export for multiple elements you will have the option to check their names, sizes and formats and a last chance to deselect the export settings you don't want to go on this batch.
A popup will show the exporting progress and will show errors if any.
If you have a presentation made at Penpot you might want to create a document that can be shared with anyone, regardless of having a Penpot account, or just to be able to use your presentation offline (essential for talks and classes). You can easily export all the artboards of a page to a single PDF file from the file menu.
Technical note about the PDF format.
@@ -62,7 +62,7 @@ title: 07· Exporting objects
Exported PDF files try to leverage the capabilities of PDF vectorial format (unpixelated zoom, select & copy texts, etc.), but cannot guarantee that 100% of SVG features will be converted perfectly to PDF. You may see differences between an object displayed inside Penpot and in the exported file. If you need an exact match, a workaround is to export the object into PNG and convert it to PDF with some of the many tools that exist for it.
Ways to start with Penpot
Penpot's main areas and features
Ways to start with Penpot
Speed your design workflow
Info of interest about Penpot
Some useful links to better understand Penpot through answers and tutorials.
-The Dev Diaries are our release notes, where we jot down every new feature, enhancement and fix included in every release. There are also kudos to community contributors <3
Wanna know what's new? take a look at our Dev Diaries.
-Suscribe to the Penpot Youtube channel to get updates when we upload new Penpot tutorials, demos of features and talks.
-If you have questions about the "Whys" or the "Hows" of Penpot we have collected and answered a bunch of the most common questions that we've been asked so far at our Frequently Asked Questions.
-We launched a community space to allow for everyone to be part of the conversation. Join the community here.
diff --git a/user-guide/introduction/quickstart.njk b/user-guide/introduction/quickstart.njk index 49f23cc..fade5ee 100644 --- a/user-guide/introduction/quickstart.njk +++ b/user-guide/introduction/quickstart.njk @@ -6,10 +6,10 @@ title: QuickstartYou can start using Penpot right in your browser or installing it in a server of your own.
-To use Penpot online point your browser to design.penpot.app and start designing. Use the latest Google Chrome or Mozilla Firefox for the best experience. We also provide specific support to WebKit (Safari / Epiphany).
You can also go to penpot.app if you want to read more about Penpot and our new releases. There, click on the Signup button. You will be asked to create an account. We only ask for an email. There are some authentication providers available, too.
-Currently, private Penpot instances only require basic Docker knowledge.
You can run your own Penpot server following the instructions at the Technical Guide
diff --git a/user-guide/layer-basics/index.njk b/user-guide/layer-basics/index.njk index 4c06923..ddf4683 100644 --- a/user-guide/layer-basics/index.njk +++ b/user-guide/layer-basics/index.njk @@ -5,7 +5,7 @@ title: 04· Layer basicsEvery object you create in Penpot’s viewport is a layer. Rectangles, ellipses, boards or text boxes are layers that you can use to build your design.
-Pages allow you to organize layers into separate sections inside a file, and are shown in separate tabs. Subdividing a file into pages gives you the ability to split your file into logically different sections so that you can organise your work. For instance, you can use pages to separate stages of the design process but keep them in the same document. Different screen sizes, features or atomic design categories are other common ways to use pages.
You can add, remove or rename pages to suit your needs.
@@ -15,14 +15,14 @@ title: 04· Layer basicsLayers: Layers are the different objects that you can place at the design viewport. At the layers panel you can see all the layers of a file page. Drag the layers to arrange them to different positions.
Layers are displayed from the bottom to the top of the layer stack, with layers above on the stack being shown on top in the image.
-Click on the eye icon to change the visibility of a layer. Click on the lock icon to lock or unlock a layer. A locked layer can not be modified.
To create a layer you have to select the type of layer by clicking the selected tool (board, rectangle, ellipse, text, image, path or curve) at the toolbar. Then you usually have to click and drag your mouse on the viewport.
Hold Shift/⇧ while creating an ellipse or a rectangle to maintain equal width and height.
There are several ways to duplicate a layer:
There are a couple ways to delete a layer.
The simplest way to select a layer is to click on it. Make sure that you have the “move” pointer selected at the toolbar.
To select multiple layers you can click and drag around the layers you want to select. You can also click more than one layer while pressing Shift/⇧. If you hold Shift/⇧ and click you can deselect layers individually.
If you want to select an element that is difficult to reach because it is under a group of elements, hold Ctrl/⌘ to make the selection ignore group areas and treat all the objects as being at the same level.
To select a layer inside a group you do double click. First click selects the group, second click selects a layer.
-At the dropdown menu (right click on a layer to show it) there's the option "Select layer" that allows the user to select one layer among the ones that are under the cursor's location.
Grouped layers can be moved, transformed or styled at the same time.
A mask is a layer that does a clipping and only shows parts of a layer or multiple layers that fall within its shape.
To move one or more layers on the viewport you have to select them first and then click and drag the selection where you want to place them. You can also use the design panel to set a precise position relative to the viewport or the board.
To resize a selected layer you can use the handles at the edges of the selection box. Make sure the cursor is in resizing mode. You can also use the design panel where you can link width and height.
To rotate selected layers you can use the handles at the edges of the selection box. Make sure the cursor is in rotation mode. If you hold Ctrl/⌘ while rotation the angle will change in 45 degree increments. You can also find this option at the design panel.
You can find the options to flip layers in their contextual menu (select the layer and right click). You also have shortcuts to do this:
Activate the scale tool by pressing K or from the main file menu to scale elements while maintaining their visual aspect. Once it is activated you can resize texts, layers and groups and preserve their aspect ratio while scaling their properties proportionally, including strokes, shadows, blurs and corners.
Aligning and distributing layers can be found at the top of the Design panel.
-Aligning will move all the selected layers to a position relative to one of them. For instance, aligning top will align the elements with the edge of the top-most element.
Distributing objects to position them vertically and horizontally with equal distances between them.
Reach specific layers with a simple search. You can also filter the layers list per layer type (board, group, mask, component, text, image and shape).
Groups and boards can have their contents expanded and collapsed. Click on the arrow at the right side to toggle the visibility of their contents.
To collapse all the layers, and just display the boards, @@ -215,7 +215,7 @@ press Shift/⇧ + left click over the right arrow of a group or a boa -
It is possible to combine shapes in a group in different ways to create more complex objects by using "boolean" operators. Boolean operators are non destructive and the original shapes remain grouped and available for more editing. There are five boolean operations available: union, difference, intersection, exclusion and flatten. Using boolean operations allows many graphic options and possibilities for your designs.
Constraints allow you to decide how layers will behave when resizing its container.
-Constraints allow you to decide how layers will behave when resizing its parent container. You can apply horizontal and vertical constraints for every layer.
To apply constraints select a layer and use the constraints map or the constraints selectors at the design panel.
Constraints are set to “Scale” by default, but you have other options.
-Select the elements of a page you want to work with in a specific moment hiding the rest so they don’t get in the way of your attention. This option is also useful to improve the performance in cases where the page has a large number of elements.
To activate focus mode:
Diversity and inclusion is a major Penpot concern and that's why we love to give support to RTL languages, unlike most design tools.
If you write in arabic, hebrew or other RTL language text direction will be automatically detected in text layers.
Objects are items that you can place in the viewport. Boards, shapes, texts, paths and graphics are objects. The following describes the different objects that you have available in Penpot, and how to get the most of them.
-A Board is a layer typically used as a container for a design. Boards are useful if you want to design for a specific screen or print size. Boards can contain other boards. First level boards are shown by default at the View mode, acting as screens of a design or pages of a document. Also, objects inside boards can be clipped. Boards are a powerful element at Penpot, opening up a ton of possibilities when creating and organizing your designs.
-You can create a board using the board tool at the toolbar or the shortcut B.
Set a custom size or choose one of the provided presets with the most common resolution for devices and standard print sizes.
TIP: Create a board around one or more selected objects using the option "Selection to board" at the menu or the shortcut Ctrl/⌘ + Alt + G.
-There are two different cases in terms of selecting boards:
Select a specific board to be the file thumbnail that will be shown at the dashboard in the file card.
To set a custom thumbnail:
Boards offer the option to clip its content (or not).
Boards offer the option to be shown as a separate board/screen in the View mode. Use this setting to decide what boards should be shown as individual items in your presentations.
Defaults
As it is very likely that the first level boards will be used as a screen and the interiors will not, there are different defaults for newly created boards.
@@ -66,28 +66,28 @@ are shown by default at the View mode, actinSometimes you don’t need the artboards to be part of your designs, but only their support to work on them. Penpot allows you to decide if the fill of an artboard will be shown in exports, you just have to check/uncheck the "Show in exports" option which is below the fill setting.
You can set guides on boards that will assist with aligning objects.
Read more about guides.
You can connect boards with other boards to create rich interactions.
Read more about prototyping.
Rectangle and ellipses are two basic “primitive” geometric shapes that are useful when starting a design.
The shortcut keys are E for ellipses and R for rectangles.
@@ -99,7 +99,7 @@ a design. -To insert text you have to activate the text tool by first clicking on the icon at the toolbar or pressing T. Then you have two ways to create a text layer:
Press Enter with a text layer selected to start editing the text content. You can style parts of the text content as rich text.
The curve tool allows a path to be created directly in a freehand mode. Select the curve tool by clicking on the icon at the toolbar or pressing Ctrl/⌘ + c.
The path created will contain a lot of points, but it is edited the same way as any other curve.
-A path is composed of two or more nodes and the line segments between them, which may also be curved. To draw a new path you have to select the path tool by clicking on the icon at the toolbar or pressing P. Then you have two ways to create the path:
To edit a node double click on a path or select and press Enter. You can choose to edit individual nodes or create new ones. Press Esc to exit node edition.
There are several options for inserting an image into a Penpot file:
Images fill the layer backgrounds by default, so they take up the entire object while maintaining the aspect ratio. This is great for flexible designs because the images can adapt to different sizes.
However, if you don't want an image to keep its aspect ratio when resizing, you just have to uncheck the option in the image settings.
Penpot allows you to prototype interactions by connecting boards, which can act as screens. Once the prototype is prepared with interactions and/or flows, it can be used at the View mode and shared through a link.
-
The classic, most usual of the prototyping actions. It takes the user from one board to the destination set in the interaction.
-It opens a board right over the current board. This action is typically used to display tooltips, modal windows or notifications.
Offset effect means that the origin board will slightly fade and move in the same direction of the destination board.
-Design projects usually need to define multiple casuistics for different devices and user journeys. Flows allow you to define one or multiple starting points within the same page so you can better organize and present your prototypes.
A flow is defined by a starting board for an interaction. Flows can be selected independently at the view mode. Each flow has its own shareable link at the View mode.
-A starting point is a board selected to be the first screen of a flow. You could set a board as a starting point just because you want this board to be the first one to be shown in the view mode, but you can also set more starting points to define different user journeys.
There are several ways to create starting points:
You can add as many flows as you want. The complete list of flows is shown at the prototype sidebar when no shape is selected.
At the view mode there’s a menu where you can access to all the flows set and easily switch between them.
You can fix the position of an object when scrolling at the presentation view. This is tipically useful for prototyping fixed headers, navbars and floating buttons.
Penpot has a variety of styling options for each object. When selected, the styling options are displayed in the design panel on the right.
-Color fills can be added to boards, shapes, texts and groups of layers.
You can add as fills:
To remove a fill from a selected object, press the “-” button in the fill section.
Here you have the anatomy of the color picker:
The color palette allows you to have a selected color library in plain sight.
You can set values for corner radius to rectangles and images. There’s also the option to edit each corner individually.
Adding shadows is easy from the design panel. You can add as many as you want.
You can set a blur for each and every object at Penpot.
Applying a lot and/or big values for blurs can affect Penpot’s performance as it requires a lot from the browser.
At Penpot you can create and join as many teams as you need and add all necessary stakeholders with no limits about team size.
-At Penpot you can create as many teams as you need and be invited to teams owned by others. Learn how to manage them.
-At the top left of the dashboard you can find the team selector.
"Your Penpot" is the name of your personal space at Penpot. It is like any other team but in which no members can be invited so that you will allways have your own private dashboard. Create or join other teams to collaborate with other Penpot users.
To create a new team go to the bottom of the team selector and press "+ Create new team". Then you will be asked to enter a team name and that's it. Once a new team is created you are be able to invite new team members.
All members can leave the team anytime from the same menu.
Only the team owner can delete a team. The option can be found at the team menu (the three dots at the right side). When deleting a team all projects and files belonging to it will be permanently deleted.
At the team settings you can see the information about how many members, projects and files belong to it. Team name and profile picture can be updated.
At the team members area you can view all the users that are inside the team and manage them according to your permissions.
These are the team roles currently available at Penpot:
More team roles will be eventually available, as well as fine grained permissions management to control members access and actions.
-An owner can transfer their ownership to another team member anytime and is requested to transfer it before leaving the team.
You can invite people to join the team using the "Invite to team" window. Add their emails separated by comma, select the role that will be assigned to them and press "Send invitation". An invitation will be sent to each of the added emails that still will need to be accepted.
Check the status of a team invitations at the "Invitations" section. Invitations can be pending (still valid but not accepted yet) or expired.
You can perform the following actions over existing invitations:
Webhooks allow other websites and apps to be notified when certain events happen on Penpot, ensuring to create integrations with other services. While we are still working on a plugin system, this is a clever and simple way to create integrations with other services.
The Penpot interface has three main areas: Dashboard, Workspace and View mode. Lets take a look at their composition and main features.
-The Dashboard is the place where you will be able to organize your files, libraries, projects and teams.
The Workspace is where you actually create your designs. You have an infinite canvas where you can work directly but you also have the ability to create and work inside boards that will help you to create pages and exportation units.
Launch the view mode to present and share your designs, comment on them and play with the interactions set at the workspace. You also have an Inspect mode where you can get properties specifications and code snippets. More about the View mode.
Penpot's default interface is dark but you can switch anytime to a light option. You have 2 ways to change the theme: