Skip to content

Commit 2d9ff78

Browse files
Merge pull request #6 from webdevnerdstuff/highlightjs
Highlightjs
2 parents 0941072 + 7644a75 commit 2d9ff78

File tree

89 files changed

+19288
-5158
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

89 files changed

+19288
-5158
lines changed

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* text=auto eol=lf
File renamed without changes.

.github/CONTRIBUTING.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,25 +25,25 @@ Update the CHANGELOG.md with the updates you made, please include the date and G
2525
When you're done making changes and you'd like to propose them for review, open your PR (pull request).
2626

2727
### Submit your PR & get it reviewed
28-
- Once you submit your PR, others from the Vue Unicorn Log community will review it with you.
28+
- Once you submit your PR, others from the Vue3 CodeBlock community will review it with you.
2929
- After that, we may have questions, check back on your PR to keep up with the conversation.
3030

3131
### Your PR is merged!
3232
Congratulations! The whole GitHub community thanks you. :sparkles:
3333

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

36-
### Keep contributing as you use Vue Unicorn Log
36+
### Keep contributing as you use Vue3 CodeBlock
3737

38-
Now that you're a part of the Vue Unicorn Log community, you can keep participating in many ways.
38+
Now that you're a part of the Vue3 CodeBlock community, you can keep participating in many ways.
3939

4040
## Types of contributions
41-
You can contribute to the Vue Unicorn Log content and site in several ways. This repo is a place to discuss and collaborate on Vue Unicorn Log! Our small, but mighty team is maintaining this repo, to preserve our bandwidth, off topic conversations will be closed.
41+
You can contribute to the Vue3 CodeBlock content and site in several ways. This repo is a place to discuss and collaborate on Vue3 CodeBlock! Our small, but mighty team is maintaining this repo, to preserve our bandwidth, off topic conversations will be closed.
4242

4343
### :mega: Discussions
4444
Discussions are where we have conversations.
4545

46-
If you'd like help troubleshooting a Vue Unicorn Log 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/vue3-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.
@@ -75,13 +75,13 @@ suggestions to improve the code or adding of additional features.
7575
## Opening a pull request
7676
You can use the GitHub user interface for some small changes, like fixing a typo or updating a readme. You can also fork the repo and then clone it locally, to view changes and run your tests on your machine.
7777

78-
## Working in the Vue Unicorn Log repository
79-
Here's some information that might be helpful while working on a Vue Unicorn Log PR:
78+
## Working in the Vue3 CodeBlock repository
79+
Here's some information that might be helpful while working on a Vue3 CodeBlock PR:
8080

8181
<!-- - [Development](/contributing/development.md) - This short guide describes how to get this app running on your local machine. -->
8282

8383
## Reviewing
84-
We (usually the Vue Unicorn Log team) review every single PR. The purpose of reviews is to create the best content we can for people who use GitHub.
84+
We (usually the Vue3 CodeBlock team) review every single PR. The purpose of reviews is to create the best content we can for people who use GitHub.
8585

8686
- Reviews are always respectful, acknowledging that everyone did the best possible job with the knowledge they had at the time.
8787
- Reviews discuss content, not the person who created it.

.github/ISSUE_TEMPLATE/BUG_REPORT.yaml

Lines changed: 1 addition & 1 deletion
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/CODE_OF_CONDUCT.md)
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)
4343
options:
4444
- label: I agree to follow this project's Code of Conduct
4545
required: true

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,5 @@ dist-ssr
2424
*.sw?
2525

2626
.stylelintcache
27+
src/plugin/themes/highlight/scss/template.scss
28+
dist/themes/highlight/scss/template.scss

.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
19.0.1

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,11 @@ All notable changes to the "vue3-code-block" plugin will be documented in this f
44
## v1.0.0
55
2023-03-16
66
[main] Initial release (@webdevnerdstuff)
7+
8+
## v1.0.15
9+
2023-04-02
10+
[main] Minor changes to fix issues after testing npm packaging. (@webdevnerdstuff)
11+
12+
## v2.0.0
13+
TBD
14+
[main] Major release update. Added in support to use either PrismJS or HighlightJS. (@webdevnerdstuff)

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
## Description
2121

22-
The Vue 3 CodeBlock component leverages the power of [PrismJS](https://prismjs.com/) to provide syntax highlighting for code blocks within your application. The component takes a prop, which is the code to be highlighted, and uses PrismJS to render the code with syntax highlighting. The component supports a variety of programming languages and can be customized with different themes to match your application's design. With this component, your users can display their code snippets with ease and clarity, making it easier to share and collaborate on code within your application.
22+
The Vue 3 CodeBlock component leverages the power of [PrismJS](https://prismjs.com/) or [PrismJS](https://highlightjs.org/)to provide syntax highlighting for code blocks within your application. The component takes a prop, which is the code to be highlighted, and uses PrismJS or Highlight.js to render the code with syntax highlighting. The component supports a variety of programming languages and can be customized with different themes to match your application's design. With this component, your users can display their code snippets with ease and clarity, making it easier to share and collaborate on code within your application.
2323

2424

2525
## Installation
@@ -41,6 +41,7 @@ npm i vue3-code-block
4141
## Dependencies
4242

4343
[PrismJS](https://prismjs.com/)
44+
[Highlight.js](https://highlightjs.org/)
4445
[Vue 3](https://vuejs.org/)
4546
[UAParser.js](https://www.npmjs.com/package/ua-parser-js)
4647

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export {};

dist/plugin/CodeBlock.vue.d.ts

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,11 @@ declare const _default: import("vue").DefineComponent<{
5353
required: false;
5454
default: string;
5555
};
56+
highlightjs: {
57+
type: BooleanConstructor;
58+
required: false;
59+
default: boolean;
60+
};
5661
indent: {
5762
type: NumberConstructor;
5863
required: false;
@@ -73,6 +78,16 @@ declare const _default: import("vue").DefineComponent<{
7378
required: false;
7479
default: string;
7580
};
81+
prismjs: {
82+
type: BooleanConstructor;
83+
required: false;
84+
default: boolean;
85+
};
86+
prismPlugin: {
87+
type: BooleanConstructor;
88+
required: false;
89+
default: boolean;
90+
};
7691
persistentCopyButton: {
7792
type: BooleanConstructor;
7893
required: false;
@@ -160,6 +175,11 @@ declare const _default: import("vue").DefineComponent<{
160175
required: false;
161176
default: string;
162177
};
178+
highlightjs: {
179+
type: BooleanConstructor;
180+
required: false;
181+
default: boolean;
182+
};
163183
indent: {
164184
type: NumberConstructor;
165185
required: false;
@@ -180,6 +200,16 @@ declare const _default: import("vue").DefineComponent<{
180200
required: false;
181201
default: string;
182202
};
203+
prismjs: {
204+
type: BooleanConstructor;
205+
required: false;
206+
default: boolean;
207+
};
208+
prismPlugin: {
209+
type: BooleanConstructor;
210+
required: false;
211+
default: boolean;
212+
};
183213
persistentCopyButton: {
184214
type: BooleanConstructor;
185215
required: false;
@@ -224,10 +254,13 @@ declare const _default: import("vue").DefineComponent<{
224254
copySuccessText: string;
225255
floatingTabs: boolean;
226256
height: string | number;
257+
highlightjs: boolean;
227258
indent: number;
228259
label: string;
229260
lang: string;
230261
maxHeight: string | number;
262+
prismjs: boolean;
263+
prismPlugin: boolean;
231264
persistentCopyButton: boolean;
232265
runTab: boolean;
233266
runText: string;

0 commit comments

Comments
 (0)