mirror
/
penpot
mirror of https://github.com/penpot/penpot.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

📎 Update docs

This commit is contained in:
Andrey Antukh 2025-12-30 09:46:16 +01:00
parent 96356c1b89
commit 9431ae6858
3 changed files with 26 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
plugins/docs/api-docs.md
View File

@ -7,14 +7,18 @@ This document shows you how to create API documentation.
If you want to see what the document will look like (the HTML that's generated), you can run the following command:
```shell
npm run create:api-docs
npm run build:doc
```
Once you've done that, you'll find the result in `./dist/apps/api-doc`
Once you've done that, you'll find the result in `./dist/doc`
#### Deploy the API Documentation
Just move to the `stable` branch in this repository and rebase it with the latest changes from the `main` branch. This will trigger the deployment at Cloudfare if the `/libs/plugin-types/index.d.ts` or the `/tools/typedoc.css` files have been updated.
Just move to the `stable` branch in this repository and rebase it with
the latest changes from the `main` branch. This will trigger the
deployment at Cloudfare if the `libs/plugin-types/index.d.ts` or the
`tools/typedoc.css` files have been updated.
Take a look at the [Penpot plugins API](https://penpot-plugins-api-doc.pages.dev/) to see what's new.

24
plugins/docs/publish-package.md
View File

@ -2,15 +2,23 @@
## Introduction
This guide details the process of publishing `plugin-types`, `plugins-styles` and `plugins-runtime` packages, which are essential for plugin development. Below is a walkthrough for publishing these packages and managing releases.
This guide details the process of publishing `plugin-types`,
`plugins-styles` and `plugins-runtime` packages, which are essential
for plugin development. Below is a walkthrough for publishing these
packages and managing releases.
## Publishing Libraries
Publishing packages enables the distribution of types and styles libraries. Currently, all packages share the same version, meaning some releases might not contain updates but will still increment the version. Follow the steps below for the automated publishing processes.
Publishing packages enables the distribution of types and styles
libraries. Currently, all packages share the same version, meaning
some releases might not contain updates but will still increment the
version. Follow the steps below for the automated publishing
processes.
### Previewing a Release
To generate a preview of the release to check if everything is as expected, run the following command:
To generate a preview of the release to check if everything is as
expected, run the following command:
```shell
git checkout main
@ -33,7 +41,8 @@ This command will:
- Create a new git tag
- Publish to NPM with the `latest` tag
Ensure everything is correct before proceeding with the git push. Once verified, execute the following commands:
Ensure everything is correct before proceeding with the git push. Once
verified, execute the following commands:
```shell
git push
@ -50,7 +59,8 @@ git merge main
git push origin stable
```
For detailed information, refer to the [Nx Release Documentation](https://nx.dev/recipes/nx-release/get-started-with-nx-release).
For detailed information, refer to the [Nx Release
Documentation](https://nx.dev/recipes/nx-release/get-started-with-nx-release).
### Creating a Preview Version
@ -60,7 +70,9 @@ To generate a preview version and avoid publishing it as the latest release, use
npm run release -- --dry-run false --latest false --preid next
```
For example, if the current version is `0.8.0` and you select the `prepatch` option as a version specifier, it will generate the version `0.8.1-next.0` and publish it with the next tag on npm.
For example, if the current version is `0.8.0` and you select the
`prepatch` option as a version specifier, it will generate the version
`0.8.1-next.0` and publish it with the next tag on npm.
### Help

5
plugins/package.json
View File

@ -27,7 +27,7 @@
"test:e2e": "nx test e2e",
"registry": "nx local-registry",
"prepare": "husky",
"create:api-docs": "typedoc --tsconfig libs/plugins-runtime/tsconfig.lib.json --customCss ./tools/typedoc.css",
"build:doc": "typedoc --tsconfig libs/plugins-runtime/tsconfig.lib.json --customCss ./tools/typedoc.css --out dist/doc",
"release": "tsx ./tools/scripts/publish.ts"
},
"private": true,
@ -87,9 +87,6 @@
"vite-plugin-static-copy": "^3.1.0",
"vitest": "1.6.0"
},
"workspaces": [
"packages/*"
],
"dependencies": {
"@angular/animations": "19.1.3",
"@angular/common": "19.1.3",