diff options
| author | kj_sh604 | 2026-03-15 16:19:35 -0400 |
|---|---|---|
| committer | kj_sh604 | 2026-03-15 16:19:35 -0400 |
| commit | bc297e5e496d9f48ef77581b7fb41fdf328a62cf (patch) | |
| tree | 66192466eef76ee4c5cf71a9788ae9fe947514d4 /dev-docs/docs/@excalidraw/excalidraw/development.mdx | |
| parent | f6538b8f1a78a7d72a41916ac79376f8c2d30193 (diff) | |
refactor: dev-docs/
Diffstat (limited to 'dev-docs/docs/@excalidraw/excalidraw/development.mdx')
| -rw-r--r-- | dev-docs/docs/@excalidraw/excalidraw/development.mdx | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/dev-docs/docs/@excalidraw/excalidraw/development.mdx b/dev-docs/docs/@excalidraw/excalidraw/development.mdx new file mode 100644 index 0000000..6070075 --- /dev/null +++ b/dev-docs/docs/@excalidraw/excalidraw/development.mdx @@ -0,0 +1,59 @@ +--- +pagination_prev: "@excalidraw/excalidraw/installation" +--- + +# Development + +This page relates to developing the `@excalidraw/excalidraw` package itself. + +## Example app + +To start the example app using the `@excalidraw/excalidraw` package, follow the below steps: + +1. Install the dependencies + + ```bash + yarn + ``` + +2. Start the example app + + ```bash + yarn start:example + ``` + + [http://localhost:3001](http://localhost:3001) will open in your default browser. + + This is the same example as the [CodeSandbox](https://codesandbox.io/p/sandbox/github/excalidraw/excalidraw/tree/master/examples/with-script-in-browser) example. + +## Releasing + +### Create a test release + +You can create a test release by posting the below comment in your pull request: + +```bash +@excalibot trigger release +``` + +Once the version is released `@excalibot` will post a comment with the release version. + +### Creating a production release + +To release the next stable version follow the below steps: + +```bash +yarn prerelease:excalidraw +``` + +You need to pass the `version` for which you want to create the release. This will make the changes needed before making the release like updating `package.json`, `changelog` and more. + +The next step is to run the `release` script: + +```bash +yarn release:excalidraw +``` + +This will publish the package. + +Right now there are two steps to create a production release but once this works fine these scripts will be combined and more automation will be done. |
