penpot-plugins/docs/api-docs.md

### Plugins API Documentation

This document shows you how to create API documentation.

#### On your local

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
```

Once you've done that, you'll find the result in `./dist/apps/api-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.

Take a look at the [Penpot plugins API](https://penpot-plugins-api-doc.pages.dev/) to see what's new.

#### Styles

If you want to make some style changes you can do it in `/tools/typedoc.css`.
feat(docs): how api docs are generated 2024-07-12 05:27:17 -05:00			`### Plugins API Documentation`

chore: update api-docs.md 2024-09-12 01:58:33 -05:00			`This document shows you how to create API documentation.`
feat(docs): how api docs are generated 2024-07-12 05:27:17 -05:00
chore: update api-docs.md 2024-09-12 01:58:33 -05:00			`#### On your local`
feat(docs): how api docs are generated 2024-07-12 05:27:17 -05:00
chore: update api-docs.md 2024-09-12 01:58:33 -05:00			`If you want to see what the document will look like (the HTML that's generated), you can run the following command:`
feat(docs): how api docs are generated 2024-07-12 05:27:17 -05:00
chore: update api-docs.md 2024-09-12 01:58:33 -05:00			```shell
			`npm run create:api-docs`
			```
feat(docs): how api docs are generated 2024-07-12 05:27:17 -05:00
chore: update api-docs.md 2024-09-12 01:58:33 -05:00			Once you've done that, you'll find the result in `./dist/apps/api-doc`
feat(docs): how api docs are generated 2024-07-12 05:27:17 -05:00
chore: update api-docs.md 2024-09-12 01:58:33 -05:00			`#### Deploy the API Documentation`
feat(docs): how api docs are generated 2024-07-12 05:27:17 -05:00
chore: update api-docs.md 2024-09-12 01:58:33 -05:00			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.
feat(docs): how api docs are generated 2024-07-12 05:27:17 -05:00
chore: update api-docs.md 2024-09-12 01:58:33 -05:00			`Take a look at the [Penpot plugins API](https://penpot-plugins-api-doc.pages.dev/) to see what's new.`
feat(docs): how api docs are generated 2024-07-12 05:27:17 -05:00
chore: update api-docs.md 2024-09-12 01:58:33 -05:00			`#### Styles`
feat(docs): how api docs are generated 2024-07-12 05:27:17 -05:00
chore: update api-docs.md 2024-09-12 01:58:33 -05:00			If you want to make some style changes you can do it in `/tools/typedoc.css`.