aboutsummaryrefslogtreecommitdiffstats
path: root/dev-docs/docs/@excalidraw/mermaid-to-excalidraw/development.mdx
diff options
context:
space:
mode:
Diffstat (limited to 'dev-docs/docs/@excalidraw/mermaid-to-excalidraw/development.mdx')
-rw-r--r--dev-docs/docs/@excalidraw/mermaid-to-excalidraw/development.mdx60
1 files changed, 60 insertions, 0 deletions
diff --git a/dev-docs/docs/@excalidraw/mermaid-to-excalidraw/development.mdx b/dev-docs/docs/@excalidraw/mermaid-to-excalidraw/development.mdx
new file mode 100644
index 0000000..818465a
--- /dev/null
+++ b/dev-docs/docs/@excalidraw/mermaid-to-excalidraw/development.mdx
@@ -0,0 +1,60 @@
+# Development
+
+This page relates to developing the `@excalidraw/mermaid-to-excalidraw` package itself.
+
+## Setting up in Local
+
+To set up the library in local, follow the below steps 👇🏼
+
+### Clone the Repository
+
+Go to [@excalidraw/mermaid-to-excalidraw](https://github.com/excalidraw/mermaid-to-excalidraw) and clone the repository to your local.
+
+
+```bash
+git clone git@github.com:excalidraw/mermaid-to-excalidraw.git
+```
+
+### Install the dependencies
+
+Using `npm`
+
+```bash
+npm install @excalidraw/mermaid-to-excalidraw
+```
+
+Using `yarn`
+
+```bash
+yarn add @excalidraw/mermaid-to-excalidraw
+```
+
+### Run the playground server
+
+```bash
+yarn start
+```
+
+This will start the playground server in port `1234` and you start playing with the playground.
+
+## Creating a test release
+
+We will soon simplify creating release via commenting on GitHub PR similar till then you can create a release by following the below steps
+
+1. Create the build
+
+```bash
+yarn build
+```
+
+This will create the dist folder which we need to publish next.
+
+2. Publish the library
+
+Update the package name and version in [package.json](https://github.com/excalidraw/mermaid-to-excalidraw/blob/master/package.json) and run the below command to publish it
+
+```bash
+yarn publish
+```
+
+And thats all your test release is successfully created 🎉