Skip to content

Commit d430e1d

Browse files
authored
Added debug mode to readme (#135)
* Added a note about debug mode * Update README.md Added image of debug mode
1 parent d02ff6a commit d430e1d

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,28 +60,34 @@ The project is configured for [pnpm](https://pnpm.io/). To install, see the [ins
6060

6161
The plugin is organized as a monorepo. There are several packages:
6262

63-
- packages/backend - Contains the business logic that reads the Figma API and converts nodes
64-
- packages/plugin-ui - Contains the common UI for the plugin
65-
- packages/eslint-config-custom - Config file for ESLint
66-
- packages/tsconfig - Collection of TSConfig files used throughout the project
63+
- `packages/backend` - Contains the business logic that reads the Figma API and converts nodes
64+
- `packages/plugin-ui` - Contains the common UI for the plugin
65+
- `packages/eslint-config-custom` - Config file for ESLint
66+
- `packages/tsconfig` - Collection of TSConfig files used throughout the project
6767

68-
- apps/plugin - This is the actual plugin assembled from the parts in backend & plugin-ui. Within this folder it's divided between:
69-
- plugin-src - loads the backend and compiles to code.js
70-
- ui-src - loads the common plugin-ui and compiles to index.html
71-
- apps/debug - This is a debug mode plugin that is a more convenient way to see all the UI elements.
68+
- `apps/plugin` - This is the actual plugin assembled from the parts in `backend` & `plugin-ui`. Within this folder it's divided between:
69+
- `plugin-src` - loads from `backend` and compiles to `code.js`
70+
- `ui-src` - loads the common `plugin-ui` and compiles to `index.html`
71+
- `apps/debug` - This is a debug mode plugin that is a more convenient way to see all the UI elements.
7272

7373
The plugin is built using Turbo which in turn builds the internal packages.
7474

7575
#### Commands
7676

7777
`pnpm run ...`
7878

79-
- `dev` - runs the app in dev mode
79+
- `dev` - runs the app in dev mode. This can be run in the Figma editor.
8080
- `build`
8181
- `build:watch`
8282
- `lint`
8383
- `format` - formats with prettier (warning: may edit files!)
8484

85+
#### Debug mode
86+
87+
When running the `dev` task, you can open `http://localhost:3000` to see the debug version of the UI.
88+
89+
<img width="600" alt="Screenshot 2024-12-13 at 16 26 43" src="https://github.com/user-attachments/assets/427fb066-70e1-47bd-8718-51f7f4d83e35" />
90+
8591
## Issues
8692

8793
The Figma file for this README and icon is also open and welcome to changes! [Check it here.](https://www.figma.com/file/8buWpm6Mpq4yK9MhbkcdJB/Figma-to-Code)

0 commit comments

Comments
 (0)