development.mdx 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. # Development
  2. This page relates to developing the `@excalidraw/mermaid-to-excalidraw` package itself.
  3. ## Setting up in Local
  4. To set up the library in local, follow the below steps 👇🏼
  5. ### Clone the Repository
  6. Go to [@excalidraw/mermaid-to-excalidraw](https://github.com/excalidraw/mermaid-to-excalidraw) and clone the repository to your local.
  7. ```bash
  8. git clone [email protected]:excalidraw/mermaid-to-excalidraw.git
  9. ```
  10. ### Install the dependencies
  11. Using `npm`
  12. ```bash
  13. npm install @excalidraw/mermaid-to-excalidraw
  14. ```
  15. Using `yarn`
  16. ```bash
  17. yarn add @excalidraw/mermaid-to-excalidraw
  18. ```
  19. ### Run the playground server
  20. ```bash
  21. yarn start
  22. ```
  23. This will start the playground server in port `1234` and you start playing with the playground.
  24. ## Creating a test release
  25. We will soon simplify creating release via commenting on GitHub PR similar till then you can create a release by following the below steps
  26. 1. Create the build
  27. ```bash
  28. yarn build
  29. ```
  30. This will create the dist folder which we need to publish next.
  31. 2. Publish the library
  32. 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
  33. ```bash
  34. yarn publish
  35. ```
  36. And thats all your test release is successfully created 🎉