-
Notifications
You must be signed in to change notification settings - Fork 1
/
readme.txt
143 lines (107 loc) · 4.91 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
=== Vaaky Highlighter ===
Contributors: raunak01
Donate link: https://www.webhat.in/
Tags: syntax highlighter, gutenberg, blocks, snippets, highlight.js, highlighter, php, js, sourcecode, code
Requires at least: 5.0
Tested up to: 6.4.2
Requires PHP: 5.6
Stable tag: 1.0.6
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Simple yet elegant syntax or code highlighter based on highlight.js. It allows you to add engaging snippet code blocks.
== Description ==
Vaaky Highlighter is a free, easy-to-use, syntax highlighting tool for WordPress. Highlighting is powered by the [Highlight.js](https://github.com/highlightjs/highlight.js) javaScript syntax highlighter with language auto-detection and zero dependencies.
Using it will be as straightforward as adding a replacement Vaaky Highlighter Sourcecode block (Gutenberg) and insert the code that you wish to highlight: Vaaky Highlighter takes care of the rest!
**Here is the [demo page](https://www.webhat.in/?page_id=626&utm_source=wordpress.org&utm_medium=readme.txt&utm_campaign=link&utm_id=vaaky_highlighter&utm_term=Theme+Demo) of all the supported themes.**
== Installation ==
= Minimum Requirements =
* PHP 5.6 or greater is recommended
* WordPress 5.0 or greater is recommended
= Automatic installation =
Automatic installation is that the best choice -- WordPress can handle the file transfer, and you won’t have to be compelled to leave your browser.
1. Go to "Plugins" in your WordPress dashboard
1. Click on "Add New"
1. Type "Vaaky Highlighter" in the search field
1. Click “Search Plugins.”
1. Once you’ve found us, you can view details about it such as the point release, rating, and description. Most importantly, of course, you can install it by clicking "Install" and WordPress will take it from there.
1. Click on Activate
= Manual installation =
1. Download the plugin archive
1. Go to "Plugins" in your WordPress dashboard
1. Click on "Add New"
1. Upload Vaaky Highlighter archive
1. Activate the plugin
Having issue? Check the WordPress codex contains [instructions on how to do this here](https://wordpress.org/support/article/managing-plugins/#manual-plugin-installation).
=== Usage ==
1. Add a Vaaky Highlighter block within your content
1. Write your code
1. Select the language (optional)
1. Save the post/page and check your in frontend
== Supported languages ==
- Apache
- Bash
- C
- C#
- C++
- CSS
- DNS Zone file
- DOS
- Django
- Dockerfile
- Go
- HTML
- XML
- Handlebars
- JSON
- Java
- JavaScript
- Markdown
- Nginx
- Objective C
- PHP
- Plaintext
- PostgreSQL & PL/pgSQL
- PowerShell
- Python
- R
- Ruby
- Rust
- SCSS
- SQL/MySQL
- Shell
- Twig
- TypeScript
- YAML/YML
== Frequently Asked Questions ==
= What library does this plugin use?
It uses [Highlight.js](https://github.com/highlightjs/highlight.js)
= What is the theme it supports =
Currently, it supports 25 themes out of which 16 are the dark theme which includes Monokai (Sublime), Visual Studio, GitHub Dark, Android Studio, etc. and 9 are the light themes which include Github, StackOverflow, Google Code, etc.
= How an add a language that is not supported by you but supported by highlightjs =
In that case, do not select any language from dropdown, highlightjs will auto-detect the language. If it still didn't work you can request for a [feature request](https://github.com/finallyRaunak/vaaky-highlighter/issues)
= Does it has line number =
No
= Does it support Classic Editor? If yes then how to add the code snippet? =
Yes, it will work in WordPress Classic Editor. You have to add it in the form of shortcode, like this `[vaakyHighlighterCode lang="php"] Write your code here.[/vaakyHighlighterCode]`.
If you know the abbreviation of the language then you can provide in `lang` attribute like php or js or cpp else ignore the attribute all together plugin will auto-detect the language and will highlight based on that.
== Screenshots ==
1. Plugin Settings Page
2. Visual Studio 2015 Theme: JavaScript Snippet
3. Visual Studio 2015 Theme: PHP Snippet
4. Visual Studio 2015 Theme: YAML Snippet
5. Sublime (Monokai) Theme: JavaScript Snippet
6. Sublime (Monokai) Theme: YAML Snippet
7. Sublime (Monokai) Theme: PHP Snippet with Scrollbar
8. Sublime (Monokai) Theme: PHP Snippet with Line Wrap
== Changelog ==
= 1.0.6 2024-01-01 =
* Fix - declare $settingOptionGroup in Settings.php to silence deprecated message [6457d69](https://github.com/finallyRaunak/vaaky-highlighter/commit/6457d698f091e2c8cbdf76896004875a561f988c)
* Tested and updated WordPress compatibility with new version
= 1.0.5 2023-09-09 =
* Fix - Notice: Trying to access array offset on value of type bool
* Tested and updated WordPress compatibility with new version
= 1.0.4 2023-05-05 =
* Tested and updated WordPress compatibility with new version
[See the changelog for all versions](https://github.com/finallyRaunak/vaaky-highlighter/blob/main/CHANGELOG.md).
== Upgrade Notice ==
There isn't any upgrade notice at this point.