Skip to content

Commit 13a6d83

Browse files
Merge pull request #29 from webdevnerdstuff/dev
Changed name to vue-code-block
2 parents f55edf9 + f05875a commit 13a6d83

18 files changed

+198
-113
lines changed

.github/CONTRIBUTING.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44

55
Before you begin:
66
- Have you read the [code of conduct](CODE_OF_CONDUCT.md)?
7-
- Check out the [existing issues](https://github.com/webdevnerdstuff/vue3-code-block/issues).
7+
- Check out the [existing issues](https://github.com/webdevnerdstuff/vue-code-block/issues).
88

99
### Don't see your issue? Open one
1010

11-
If you spot something new, open an issue using a [template](https://github.com/webdevnerdstuff/vue3-code-block/issues/new/choose). We'll use the issue to have a conversation about the problem you want to fix.
11+
If you spot something new, open an issue using a [template](https://github.com/webdevnerdstuff/vue-code-block/issues/new/choose). We'll use the issue to have a conversation about the problem you want to fix.
1212

1313
### Ready to make a change? Fork the repo
1414

@@ -31,7 +31,7 @@ When you're done making changes and you'd like to propose them for review, open
3131
### Your PR is merged!
3232
Congratulations! The whole GitHub community thanks you. :sparkles:
3333

34-
Once your PR is merged, you will be proudly listed as a contributor in the [contributor chart](https://github.com/webdevnerdstuff/vue3-code-block/graphs/contributors).
34+
Once your PR is merged, you will be proudly listed as a contributor in the [contributor chart](https://github.com/webdevnerdstuff/vue-code-block/graphs/contributors).
3535

3636
### Keep contributing as you use Vue3 CodeBlock
3737

@@ -43,12 +43,12 @@ You can contribute to the Vue3 CodeBlock content and site in several ways. This
4343
### :mega: Discussions
4444
Discussions are where we have conversations.
4545

46-
If you'd like help troubleshooting a Vue3 CodeBlock PR you're working on, have a great new idea, or want to share something amazing you've learned, join us in [discussions](https://github.com/webdevnerdstuff/vue3-code-block/discussions).
46+
If you'd like help troubleshooting a Vue3 CodeBlock PR you're working on, have a great new idea, or want to share something amazing you've learned, join us in [discussions](https://github.com/webdevnerdstuff/vue-code-block/discussions).
4747

4848
### :beetle: Issues
4949
[Issues](https://docs.github.com/en/github/managing-your-work-on-github/about-issues) are used to track tasks that contributors can help with.
5050

51-
If you've found something in the content or the website that should be updated, search open issues to see if someone else has reported the same thing. If it's something new, open an issue using a [template](https://github.com/webdevnerdstuff/vue3-code-block/issues/new/choose). We'll use the issue to have a conversation about the problem you want to fix.
51+
If you've found something in the content or the website that should be updated, search open issues to see if someone else has reported the same thing. If it's something new, open an issue using a [template](https://github.com/webdevnerdstuff/vue-code-block/issues/new/choose). We'll use the issue to have a conversation about the problem you want to fix.
5252

5353
### :hammer_and_wrench: Pull requests
5454
A [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) is a way to suggest changes in our repository.
@@ -66,10 +66,10 @@ You can browse existing issues to find something that needs help!
6666
### Labels
6767
Labels can help you find an issue you'd like to help with.
6868

69-
- The [`help wanted` label](https://github.com/webdevnerdstuff/vue3-code-block/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement) is for problems or updates that anyone in the community can start working on.
70-
- The [`documentation` label](https://github.com/webdevnerdstuff/vue3-code-block/issues?q=is%3Aopen+is%3Aissue+label%3Adocumentation) is for problems or updates relating to the README.MD documentation.
71-
- The [`bug` label](https://github.com/webdevnerdstuff/vue3-code-block/issues?q=is%3Aopen+is%3Aissue+label%3Abug) is for problems with the code and bugs.
72-
- The [`enhancement` label](https://github.com/webdevnerdstuff/vue3-code-block/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement) is for
69+
- The [`help wanted` label](https://github.com/webdevnerdstuff/vue-code-block/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement) is for problems or updates that anyone in the community can start working on.
70+
- The [`documentation` label](https://github.com/webdevnerdstuff/vue-code-block/issues?q=is%3Aopen+is%3Aissue+label%3Adocumentation) is for problems or updates relating to the README.MD documentation.
71+
- The [`bug` label](https://github.com/webdevnerdstuff/vue-code-block/issues?q=is%3Aopen+is%3Aissue+label%3Abug) is for problems with the code and bugs.
72+
- The [`enhancement` label](https://github.com/webdevnerdstuff/vue-code-block/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement) is for
7373
suggestions to improve the code or adding of additional features.
7474

7575
## Opening a pull request

.github/ISSUE_TEMPLATE/BUG_REPORT.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ body:
3939
id: terms
4040
attributes:
4141
label: Code of Conduct
42-
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/webdevnerdstuff/vue3-code-block/blob/main/.github/CODE_OF_CONDUCT.md)
42+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/webdevnerdstuff/vue-code-block/blob/main/.github/CODE_OF_CONDUCT.md)
4343
options:
4444
- label: I agree to follow this project's Code of Conduct
4545
required: true

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Change Log
2-
All notable changes to the "vue3-code-block" plugin will be documented in this file.
2+
All notable changes to the "vue-code-block" plugin will be documented in this file.
33

44
## v2.2.13
55
11-09-2023

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
<p align="center">
2-
<img alt="Vue" width="100" src="https://github.com/webdevnerdstuff/vue3-code-block/raw/main/public/vue.svg">
2+
<img alt="Vue" width="100" src="https://github.com/webdevnerdstuff/vue-code-block/raw/main/public/vue.svg">
33
</p>
44

55
<p>
66
<h1 align="center">Vue 3 CodeBlock</h1>
77
</p>
88

99
<p align="center">
10-
<a href="https://www.npmjs.com/package/@wdns/vue3-code-block">
11-
<img src="https://img.shields.io/npm/v/@wdns/vue3-code-block?color=1867c0&logo=npm" alt="NPM Package">
10+
<a href="https://www.npmjs.com/package/@wdns/vue-code-block">
11+
<img src="https://img.shields.io/npm/v/@wdns/vue-code-block?color=1867c0&logo=npm" alt="NPM Package">
1212
</a>
1313
&nbsp;
14-
<a href="https://github.com/webdevnerdstuff/vue3-code-block">
14+
<a href="https://github.com/webdevnerdstuff/vue-code-block">
1515
<img src="https://img.shields.io/badge/GitHub-WebDevNerdStuff-brightgreen.svg?logo=github" alt="@WebDevNerdStuff">
1616
</a>
1717
</p>
@@ -26,17 +26,17 @@ The Vue 3 CodeBlock component leverages the power of [PrismJS](https://prismjs.c
2626

2727
Using [pnpm](https://pnpm.io/):
2828
```
29-
pnpm add @wdns/vue3-code-block
29+
pnpm add @wdns/vue-code-block
3030
```
3131

3232
Using npm:
3333
```
34-
npm i @wdns/vue3-code-block
34+
npm i @wdns/vue-code-block
3535
```
3636

3737
## Documentation
3838

39-
[Documentation & Demo](https://webdevnerdstuff.github.io/vue3-code-block/)
39+
[Documentation & Demo](https://webdevnerdstuff.github.io/vue-code-block/)
4040

4141
## Dependencies
4242

@@ -48,10 +48,10 @@ npm i @wdns/vue3-code-block
4848

4949
## Change Log
5050

51-
[CHANGELOG](https://github.com/webdevnerdstuff/vue3-code-block/blob/main/CHANGELOG.md)
51+
[CHANGELOG](https://github.com/webdevnerdstuff/vue-code-block/blob/main/CHANGELOG.md)
5252

5353

5454
## License
5555

5656
Copyright (c) 2023 WebDevNerdStuff
57-
Licensed under the [MIT license](https://github.com/webdevnerdstuff/vue3-code-block/blob/main/LICENSE.md).
57+
Licensed under the [MIT license](https://github.com/webdevnerdstuff/vue-code-block/blob/main/LICENSE.md).

dist/scss/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,22 @@ If you would like to contribute any missing theme tab styles please follow the i
55
_I am not currently accepting any custom themes to be integrated into the plugin at this time._
66

77
## 🚀 Getting Started
8-
Before you get started, please read the [Contributing](https://github.com/webdevnerdstuff/vue3-code-block/blob/main/.github/CONTRIBUTING.md) and [Contributor Covenant Code of Conduct](https://github.com/webdevnerdstuff/vue3-code-block/blob/main/.github/CODE_OF_CONDUCT.md) pages.
8+
Before you get started, please read the [Contributing](https://github.com/webdevnerdstuff/vue-code-block/blob/main/.github/CONTRIBUTING.md) and [Contributor Covenant Code of Conduct](https://github.com/webdevnerdstuff/vue-code-block/blob/main/.github/CODE_OF_CONDUCT.md) pages.
99

1010
1. Fork the repository.
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`.
1414
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. The playground page will open automatically or can be viewed 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/`. The base site link will also be working.
15+
6. You can view the demo site at the link provided by vite that will display in the console. Ex. `http://localhost:5173/vue-code-block/`
16+
7. The playground page will open automatically or can be viewed by adding `playground/` to the demo site link provided by vite that will display in the console. Ex. `http://localhost:5173/vue-code-block/playground/`. The base site link will also be working.
1717

1818
## 📋 Additional notes
1919
Make sure you are not adding a theme that already exists.
2020

2121
When selecting colors for the tabs, use colors from the themes stylesheet. Generally a green color for `success`, red color for `failed`. If the theme does not have a color for `success` or `failed`, use the default variables `--v-cb-success` and `--v-cb-failed`.
2222

23-
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.
23+
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/vue-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.
2424

2525
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.
2626

0 commit comments

Comments
 (0)