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

📚 Update documentation

This commit is contained in:
Andrey Antukh 2025-12-30 12:12:26 +01:00
parent d20c011db2
commit 19853b832b
5 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -7,7 +7,7 @@ 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: If you want to see what the document will look like (the HTML that's generated), you can run the following command:
```shell ```shell
npm run build:doc pnpm run build:doc
``` ```
Once you've done that, you'll find the result in `./dist/doc` Once you've done that, you'll find the result in `./dist/doc`

6
plugins/docs/create-angular-plugin.md
View File

@ -13,7 +13,7 @@ Let's dive in.
First, you need to create the scaffolding for your plugin. Use the following command, replacing `example-plugin` with the name of your plugin: First, you need to create the scaffolding for your plugin. Use the following command, replacing `example-plugin` with the name of your plugin:
```sh ```sh
npx nx g @nx/angular:app example-plugin --directory=apps/example-plugin --bundler=esbuild pnpx nx g @nx/angular:app example-plugin --directory=apps/example-plugin --bundler=esbuild
``` ```
### Step 2: Configure the Manifest ### Step 2: Configure the Manifest
@ -125,7 +125,7 @@ console.log('Hello Plugin');
Run this command: Run this command:
```sh ```sh
npx nx run example-plugin:init pnpx nx run example-plugin:init
``` ```
This will run two tasks: `serve`, the usual Angular server, and `buildPlugin`, which will compile the `plugin.ts` file. This will run two tasks: `serve`, the usual Angular server, and `buildPlugin`, which will compile the `plugin.ts` file.
@ -143,7 +143,7 @@ You can also open the Plugin manager modal via:
### Step 9: Build plugin ### Step 9: Build plugin
``` ```
npx nx run example-plugin:build pnpx nx run example-plugin:build
``` ```
### Learn More About Plugin Development ### Learn More About Plugin Development

4
plugins/docs/create-plugin.md
View File

@ -13,7 +13,7 @@ Let's dive in.
First, you need to create the scaffolding for your plugin. Use the following command, replacing `example-plugin` with the name of your plugin: First, you need to create the scaffolding for your plugin. Use the following command, replacing `example-plugin` with the name of your plugin:
```sh ```sh
npx nx g @nx/web:application example-plugin --directory=apps/example-plugin pnpx nx g @nx/web:application example-plugin --directory=apps/example-plugin
``` ```
### Step 2: Migrate eslint to ESM ### Step 2: Migrate eslint to ESM
@ -73,7 +73,7 @@ Update your `tsconfig.app.json` to include the necessary TypeScript files for yo
To preview your plugin, start a static server by running: To preview your plugin, start a static server by running:
```sh ```sh
npx nx run example-plugin:build --watch & npx nx run example-plugin:preview pnpx nx run example-plugin:build --watch & pnpx nx run example-plugin:preview
``` ```
### Step 7: Add TS parser to eslint ### Step 7: Add TS parser to eslint

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

@ -22,7 +22,7 @@ expected, run the following command:
```shell ```shell
git checkout main git checkout main
npm run release pnpm run release
``` ```
### Generating a Real Release ### Generating a Real Release
@ -30,7 +30,7 @@ npm run release
To create an actual release, disable the dry-run option: To create an actual release, disable the dry-run option:
```shell ```shell
npm run release -- --dry-run false pnpm run release -- --dry-run false
``` ```
This command will: This command will:
@ -67,7 +67,7 @@ Documentation](https://nx.dev/recipes/nx-release/get-started-with-nx-release).
To generate a preview version and avoid publishing it as the latest release, use: To generate a preview version and avoid publishing it as the latest release, use:
```shell ```shell
npm run release -- --dry-run false --latest false --preid next pnpm run release -- --dry-run false --latest false --preid next
``` ```
For example, if the current version is `0.8.0` and you select the For example, if the current version is `0.8.0` and you select the
@ -79,7 +79,7 @@ For example, if the current version is `0.8.0` and you select the
To see more options, run: To see more options, run:
```shell ```shell
npm run release -- --help pnpm run release -- --help
``` ```
## Important Reminders ## Important Reminders

4
plugins/docs/test-e2e.md
View File

@ -17,7 +17,7 @@
Use the following command to execute the E2E tests: Use the following command to execute the E2E tests:
```bash ```bash
npm run test:e2e pnpm run test:e2e
``` ```
### Writing Tests ### Writing Tests
@ -77,5 +77,5 @@
If you need to refresh all the snapshopts run the test with the update option: If you need to refresh all the snapshopts run the test with the update option:
```bash ```bash
npm run test:e2e -- --update pnpm run test:e2e -- --update
``` ```