Skip to content

Changed name to vue-code-block #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

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

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

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

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

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

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).
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).

### Keep contributing as you use Vue3 CodeBlock

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

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).
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).

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

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

### :hammer_and_wrench: Pull requests
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.
Expand All @@ -66,10 +66,10 @@ You can browse existing issues to find something that needs help!
### Labels
Labels can help you find an issue you'd like to help with.

- 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.
- 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.
- 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.
- The [`enhancement` label](https://github.com/webdevnerdstuff/vue3-code-block/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement) is for
- 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.
- 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.
- 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.
- The [`enhancement` label](https://github.com/webdevnerdstuff/vue-code-block/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement) is for
suggestions to improve the code or adding of additional features.

## Opening a pull request
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/BUG_REPORT.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ body:
id: terms
attributes:
label: Code of Conduct
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)
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)
options:
- label: I agree to follow this project's Code of Conduct
required: true
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Change Log
All notable changes to the "vue3-code-block" plugin will be documented in this file.
All notable changes to the "vue-code-block" plugin will be documented in this file.

## v2.2.13
11-09-2023
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
<p align="center">
<img alt="Vue" width="100" src="https://github.com/webdevnerdstuff/vue3-code-block/raw/main/public/vue.svg">
<img alt="Vue" width="100" src="https://github.com/webdevnerdstuff/vue-code-block/raw/main/public/vue.svg">
</p>

<p>
<h1 align="center">Vue 3 CodeBlock</h1>
</p>

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

Using [pnpm](https://pnpm.io/):
```
pnpm add @wdns/vue3-code-block
pnpm add @wdns/vue-code-block
```

Using npm:
```
npm i @wdns/vue3-code-block
npm i @wdns/vue-code-block
```

## Documentation

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

## Dependencies

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

## Change Log

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


## License

Copyright (c) 2023 WebDevNerdStuff
Licensed under the [MIT license](https://github.com/webdevnerdstuff/vue3-code-block/blob/main/LICENSE.md).
Licensed under the [MIT license](https://github.com/webdevnerdstuff/vue-code-block/blob/main/LICENSE.md).
8 changes: 4 additions & 4 deletions dist/scss/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,22 @@ If you would like to contribute any missing theme tab styles please follow the i
_I am not currently accepting any custom themes to be integrated into the plugin at this time._

## 🚀 Getting Started
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.
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.

1. Fork the repository.
2. Clone the forked repository to your local machine.
3. Create a new branch for your changes.
4. Install the node packages `pnpm i`. Please do not use `npm` or `yarn`.
5. Run the development server with the developer playground `pnpm play`.
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/`
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.
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/`
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.

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

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`.

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

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.

Expand Down
Loading