Skip to content

Commit 57a5067

Browse files
Adding playground to doc
1 parent 27cdb51 commit 57a5067

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

src/plugin/styles/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ Before you get started, please read the [Contributing](https://github.com/webdev
1111
2. Clone the forked repository to your local machine.
1212
3. Create a new branch for your changes.
1313
4. Install the node packages `pnpm i`. Please do not use `npm` or `yarn`.
14-
5. Run the development server `pnpm watch`.
15-
6. You can view the demo site at the link provided by vite that will display in the console.
14+
5. Run the development server with the developer playground `pnpm play`.
15+
6. You can view the demo site at the link provided by vite that will display in the console. Ex. `http://localhost:5173/vue3-code-block/`
16+
7. You can view the playground page by adding `playground/` to the demo site link provided by vite that will display in the console. Ex. `http://localhost:5173/vue3-code-block/playground/`
1617

1718
## 📋 Additional notes
1819
Make sure you are not adding a theme that already exists.
@@ -21,7 +22,9 @@ When selecting colors for the tabs, use colors from the themes stylesheet. Gener
2122

2223
Do not change other variable colors. Please stick to the theme you are adding. If you have a suggestion for changing a variable color already defined, please open a [discussion](https://github.com/webdevnerdstuff/vue3-code-block/discussions). The reason we have the variables is to allow users to customize the colors to their liking if they do not like the defaults already created.
2324

24-
Make sure your `css` and `scss` files are using tabbed spacing. When adding themes, do not change or alter any other files than the ones mentioned below. If you have a bug fix please make your changes in a separate branch and create a separate pull request.
25+
Make sure your `css` and `scss` files are using tabbed spacing. When adding themes, do not change or alter any other files than the ones mentioned below. If you have a bug fix please make your changes in a separate branch and create a separate pull request.
26+
27+
Do not commit the `PlaygroundPage.vue` file. This is only for testing purposes.
2528

2629
## ⌨ Add new theme variables
2730
Update `cssVariables.css` by including the new theme variables. All values must use the [hsl](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/hsl) color format.

0 commit comments

Comments
 (0)