| @@ -1,31 +1,54 @@ | ||
| 1 | -=== Code Block Pro === | |
| 1 | +=== Code Block Pro - Beautiful Syntax Highlighting === | |
| 2 | 2 | Contributors: kbat82 |
| 3 | -Tags: block, code, syntax, highlighting, snippet | |
| 4 | -Tested up to: 6.0 | |
| 5 | -Stable tag: 1.1.0 | |
| 3 | +Tags: block, code, syntax, snippet, highlighter, JavaScript, php, vs code | |
| 4 | +Tested up to: 6.1 | |
| 5 | +Stable tag: 1.13.0 | |
| 6 | 6 | License: GPL-2.0-or-later |
| 7 | 7 | License URI: https://www.gnu.org/licenses/gpl-2.0.html |
| 8 | 8 | |
| 9 | -Code highlighting powered by the VS Code engine | |
| 9 | +Code highlighting powered by the VS Code engine. Performance focused. No bloat. | |
| 10 | 10 | |
| 11 | 11 | == Description == |
| 12 | 12 | |
| 13 | -Show off your beautiful code. This plugin provides you with an editor that runs your code directly through the same rendering engine that is used by the popular VS Code editor. This provides fast, native, code highlighting that renders perfectly in any language and theme supported by VS Code. | |
| 13 | +Show off your beautiful code, don't just display it! This block plugin provides you with a code block editor that runs your code directly through the same rendering engine that is used by the popular VS Code editor. This block provides fast, native, code highlighting that renders perfectly in any language and theme supported by VS Code. | |
| 14 | 14 | |
| 15 | -Beautiful syntax highlighting made easy. | |
| 15 | +Beautiful syntax highlighting that makes sense. | |
| 16 | 16 | |
| 17 | +Visit [code-block-pro.com](https://code-block-pro.com/?utm_campaign=plugin&utm_source=readme-body&utm_medium=textlink) to learn more. | |
| 18 | + | |
| 19 | += Values = | |
| 20 | +- Performance first - Web vitals. Pre-rendering. Minimal asset loading. | |
| 21 | +- Lightweight - No bloat. Simple functions. Clean, maintainable code. | |
| 22 | +- Practical/useful - Focused on the user experience and presentation. | |
| 23 | +- Beautiful - Your code should look great! | |
| 24 | + | |
| 25 | +Star [Code Block Pro](https://github.com/KevinBatdorf/code-block-pro) on GitHub! | |
| 26 | + | |
| 17 | 27 | = Features = |
| 18 | -- Includes 28 themes built in to choose from. | |
| 28 | +- Includes 25+ built-in themes to choose from. | |
| 19 | 29 | - Supports over 140 programming languages |
| 20 | -- Optionally add a copy button to let users copy the code | |
| 21 | -- Native Gutenberg block output - no special requirements | |
| 22 | -- No frontend JavaScript required - works in headless mode | |
| 30 | +- Modern programming web fonts - locally hosted | |
| 31 | +- Line numbers | |
| 32 | +- Line highlighting | |
| 33 | +- Blur highlighting | |
| 34 | +- Header styles | |
| 35 | +- Footer styles | |
| 36 | +- Copy button | |
| 37 | +- Native Gutenberg block | |
| 38 | +- Core functionality works in headless mode (see FAQ) | |
| 39 | +- Converting from the default code block (and others) | |
| 40 | +- Max height with scrollable section (optional expand button) | |
| 23 | 41 | |
| 24 | 42 | = More info = |
| 25 | 43 | - Follow [@kevinbatdorf](https://twitter.com/kevinbatdorf) on Twitter |
| 26 | 44 | - View on [GitHub](https://github.com/KevinBatdorf/code-block-pro) |
| 27 | 45 | |
| 46 | += Tips = | |
| 47 | +- Try combining line highlighting with the blur effect to add some extra depth and focus on the important parts of the code without losing context | |
| 48 | +- All settings are per block, but some settings are remembered when you add the next block. | |
| 49 | +- Add a link in the code footer (some footers support this, not all) that points to a https://codepen.io demo | |
| 50 | + | |
| 28 | 51 | = Included VS Code Themes = |
| 29 | 52 | - Dark Plus |
| 30 | 53 | - Dracula Soft |
| 31 | 54 | - Dracula |
| @@ -31,9 +54,9 @@ | ||
| 31 | 54 | - Dracula |
| 32 | 55 | - GitHub Dark Dimmed |
| 33 | 56 | - Github Dark |
| 34 | 57 | - Github Light |
| 35 | -- HC Light | |
| 58 | +- HC Light - temporarily disabled | |
| 36 | 59 | - Light Plus |
| 37 | 60 | - Material Darker |
| 38 | 61 | - Material Default |
| 39 | 62 | - Material Lighter |
| @@ -54,8 +77,156 @@ | ||
| 54 | 77 | - Solarized Light |
| 55 | 78 | - Vitesse Dark |
| 56 | 79 | - Vitesse Light |
| 57 | 80 | |
| 81 | +Get more themes at [code-block-pro.com/themes](https://code-block-pro.com/themes?utm_campaign=themes&utm_source=readme-body&utm_medium=textlink) | |
| 82 | + | |
| 83 | += Included Coding Languages = | |
| 84 | +- ABAP | |
| 85 | +- ActionScript 3 | |
| 86 | +- Ada | |
| 87 | +- ANSI (control codes rendered) | |
| 88 | +- Apache | |
| 89 | +- Apex | |
| 90 | +- APL | |
| 91 | +- AppleScript | |
| 92 | +- Ara | |
| 93 | +- ASM | |
| 94 | +- Astro | |
| 95 | +- Awk | |
| 96 | +- Ballerina | |
| 97 | +- BAT | |
| 98 | +- Berry | |
| 99 | +- BibTeX | |
| 100 | +- BICEP | |
| 101 | +- Blade | |
| 102 | +- C | |
| 103 | +- Cadence | |
| 104 | +- Clarity | |
| 105 | +- Clojure | |
| 106 | +- CMake | |
| 107 | +- COBOL | |
| 108 | +- CodeQL | |
| 109 | +- CoffeeScript | |
| 110 | +- C++ | |
| 111 | +- Crystal | |
| 112 | +- C# | |
| 113 | +- CSS | |
| 114 | +- CUE | |
| 115 | +- D | |
| 116 | +- Dart | |
| 117 | +- DAX | |
| 118 | +- Diff | |
| 119 | +- Docker | |
| 120 | +- DreamMaker | |
| 121 | +- Elixir | |
| 122 | +- Elm | |
| 123 | +- ERB | |
| 124 | +- Erlang | |
| 125 | +- Fish | |
| 126 | +- F# | |
| 127 | +- Gherkin | |
| 128 | +- Git Commit | |
| 129 | +- Git Rebase | |
| 130 | +- Gnuplot | |
| 131 | +- Go | |
| 132 | +- GraphQL | |
| 133 | +- Groovy | |
| 134 | +- Hack | |
| 135 | +- HAML | |
| 136 | +- Handlebars | |
| 137 | +- Haskell | |
| 138 | +- HCL | |
| 139 | +- HLSL | |
| 140 | +- HTML | |
| 141 | +- INI | |
| 142 | +- Java | |
| 143 | +- JavaScript | |
| 144 | +- Jinja HTML | |
| 145 | +- JSON | |
| 146 | +- JSONC | |
| 147 | +- JSONnet | |
| 148 | +- JSSM | |
| 149 | +- JSX | |
| 150 | +- Julia | |
| 151 | +- Kotlin | |
| 152 | +- LaTeX | |
| 153 | +- LESS | |
| 154 | +- Liquid | |
| 155 | +- Lisp | |
| 156 | +- Logo | |
| 157 | +- Lua | |
| 158 | +- Make | |
| 159 | +- Markdown | |
| 160 | +- Marko | |
| 161 | +- MATLAB | |
| 162 | +- MDX | |
| 163 | +- Mermaid | |
| 164 | +- Nginx | |
| 165 | +- Nim | |
| 166 | +- Nix | |
| 167 | +- Objective-C | |
| 168 | +- Objective-C++ | |
| 169 | +- OCaml | |
| 170 | +- Pascal | |
| 171 | +- Perl | |
| 172 | +- PHP | |
| 173 | +- PLSQL | |
| 174 | +- PostCSS | |
| 175 | +- PowerShell | |
| 176 | +- Power Query | |
| 177 | +- Prisma | |
| 178 | +- Prolog | |
| 179 | +- Pug | |
| 180 | +- Puppet | |
| 181 | +- PureScript | |
| 182 | +- Python | |
| 183 | +- R | |
| 184 | +- Raku | |
| 185 | +- Razor | |
| 186 | +- Rel | |
| 187 | +- RISC-V | |
| 188 | +- RST | |
| 189 | +- Ruby | |
| 190 | +- Rust | |
| 191 | +- SAS | |
| 192 | +- Sass | |
| 193 | +- Scala | |
| 194 | +- Scheme | |
| 195 | +- SCSS | |
| 196 | +- ShaderLab | |
| 197 | +- ShellScript (bash, zsh, sh, shell) | |
| 198 | +- Smalltalk | |
| 199 | +- Solidity | |
| 200 | +- SPARQL | |
| 201 | +- SQL | |
| 202 | +- SSH Config | |
| 203 | +- Stata | |
| 204 | +- Stylus | |
| 205 | +- Svelte | |
| 206 | +- Swift | |
| 207 | +- SystemVerilog | |
| 208 | +- TASL | |
| 209 | +- TCL | |
| 210 | +- TeX | |
| 211 | +- TOML | |
| 212 | +- TSX | |
| 213 | +- Turtle | |
| 214 | +- Twig | |
| 215 | +- TypeScript | |
| 216 | +- VB | |
| 217 | +- Verilog | |
| 218 | +- VHDL | |
| 219 | +- VimL | |
| 220 | +- Vue HTML | |
| 221 | +- Vue | |
| 222 | +- WASM | |
| 223 | +- Wenyan | |
| 224 | +- XML | |
| 225 | +- XSL | |
| 226 | +- YAML | |
| 227 | +- ZenScript | |
| 228 | + | |
| 58 | 229 | == Installation == |
| 59 | 230 | |
| 60 | 231 | 1. Activate the plugin through the 'Plugins' screen in WordPress |
| 61 | 232 | |
| @@ -60,26 +231,158 @@ | ||
| 60 | 231 | 1. Activate the plugin through the 'Plugins' screen in WordPress |
| 61 | 232 | |
| 62 | 233 | == Frequently Asked Questions == |
| 63 | 234 | |
| 64 | -= I'm not using the Copy feature = | |
| 235 | += Font size is too small/big = | |
| 65 | 236 | |
| 66 | -You can add the following snippet to your functions.php file to prevent loading the related script. The script is only required if you are using the copy feature, so you can safely remove it without concern. | |
| 67 | -` | |
| 68 | -add_action('wp_enqueue_scripts', function() { | |
| 69 | - wp_dequeue_script('kevinbatdorf-code-block-pro-view-script'); | |
| 70 | -}); | |
| 71 | -` | |
| 237 | +Look under the "Styling" tab and turn on "Clamp Values", which will compute the rem values relative to a 16px-24px base * the selected rem values. e.g. clamp(20px, 1.25rem, 30px). | |
| 72 | 238 | |
| 239 | += How to use in headless = | |
| 240 | + | |
| 241 | +Themes are rendered inside the editor as you type or make changes, so the code block itself will work without CSS or JavaScript. However, the font loading, copy button, and line highlighting require a tiny bit of JavaScript to funciton. Additionally, line blur uses a tiny bit of CSS which you will need to load in yourself or impliment your own. The code tokens and theme styles are inline though, so no need to manipulate the DOM. | |
| 242 | + | |
| 73 | 243 | == Screenshots == |
| 74 | 244 | |
| 75 | -1. Quickly swap over themes in the editor | |
| 76 | -2. A view from the front end with the copy button | |
| 245 | +1. Choose from more than 25 themes. | |
| 246 | +2. Customize fonts, themes, and behavior. | |
| 247 | +3. Disable padding and inline the code for a fluent experience. | |
| 248 | +4. Use highlighting and blur to focus on parts of the code. | |
| 249 | +5. ANSI support for rendering control sequences | |
| 77 | 250 | |
| 78 | 251 | == Changelog == |
| 79 | 252 | |
| 80 | -= 1.1.0 = | |
| 81 | -- Add filters to hook into output | |
| 82 | -- Set copy button on by default | |
| 253 | += 1.13.0 - 2023-02-05 = | |
| 254 | +- Feature: Add scrollable max height area with no button (Max Height panel) | |
| 255 | +- Feature: Add expanding code area with max height based online number | |
| 256 | +- Feature: Added ANSI rendering support - some themes do not look perfect yet | |
| 257 | +- Fix: Disabled font ligatures in the editor as it broke cursor positioning on wraps | |
| 83 | 258 | |
| 84 | -= 1.0.0 = | |
| 259 | += 1.12.0 - 2023-01-28 = | |
| 260 | +- Feature: Added Ara, Power Query, and DAX language support | |
| 261 | +- Fix: Fixed preview output on theme selection | |
| 262 | +- Fix: Fixed theme selection font rendering (to match preview better) | |
| 263 | + | |
| 264 | += 1.11.3 - 2023-01-08 = | |
| 265 | +- Fix: Encode and decode html entities to prevent script tag bug | |
| 266 | + | |
| 267 | += 1.11.2 - 2023-01-04 = | |
| 268 | +- Fix: Update shiki renderer wasm loader to use ArrayBuffer | |
| 269 | +- Tweak: Expose init function as global to allow late init | |
| 270 | + | |
| 271 | += 1.11.1 - 2023-01-04 = | |
| 272 | +- Fix: Revert code parser as there is a wasm loading error | |
| 273 | + | |
| 274 | += 1.11.0 - 2023-01-03 = | |
| 275 | +- Feature: Add theme name text search | |
| 276 | +- Feature: Add theme visibility manager to limit visible themes | |
| 277 | +- Tweak: Show better error when theme is missing | |
| 278 | +- Fix: Renderer source url has a double slash | |
| 279 | + | |
| 280 | += 1.10.0 - 2022-12-21 = | |
| 281 | +- Feature: Add footer with left aligned text | |
| 282 | +- Tweak: Load scripts (copy button, highlight) on multiple lifecycle points | |
| 283 | +- Tweak: Make the above scripts idempotent so they can run multiple times safely | |
| 284 | +- Fix: Removes inner focus outline from Gutenberg update | |
| 285 | + | |
| 286 | += 1.9.3 - 2022-12-05 = | |
| 287 | +- Fix: Adjusted editor padding for line numbers to better match the front end | |
| 288 | +- Fix: Removed the TW border default in the editor as it was overriding some wp defaults | |
| 289 | +- Fix: Updated a typo on the word "focus" | |
| 290 | +- Testing: Adds coverage for every main feature | |
| 291 | + | |
| 292 | += 1.9.2 - 2022-11-22 = | |
| 293 | +- Compatibility: Adds a method override to allow users to activate when prismatic is installed | |
| 294 | + | |
| 295 | += 1.9.1 - 2022-11-21 = | |
| 296 | +- Fix: Fixed a situations where the highlighter was miscalculating its width | |
| 297 | + | |
| 298 | += 1.9.0 - 2022-11-20 = | |
| 299 | +- Feature: Added line highlights | |
| 300 | +- Feature: Added blur effect to highlight lines | |
| 301 | +- Tweak: Added the copy button to the editor preview | |
| 302 | +- Tweak: Removed HC Light - will follow up on rendering issues | |
| 303 | +- Fix: Selected text no longer leaves padding exposed on the right | |
| 304 | + | |
| 305 | += 1.8.0 - 2022-11-17 = | |
| 306 | +- Feature: Added footer styles | |
| 307 | +- Accessibility: Increased line number color contrast | |
| 308 | +- Accessibility: Increased copy button contrast | |
| 309 | +- Tweak: Disabled autocomplete on settings inputs | |
| 310 | +- Tweak: Added help context to variations that have inputs | |
| 311 | +- Fix: Fixed a bug where disabling padding on one block would update all | |
| 312 | +- Fix: Line numbers + disabled padding no longer formats weird in the editor | |
| 313 | +- Fix: Scrollbars are now using auto instead of scroll | |
| 314 | +- Fix: The loading screen on the theme viewer now fills the container | |
| 315 | +- Fix: With line numbers, changing the font now will recalculate the width | |
| 316 | + | |
| 317 | += 1.7.0 - 2022-11-09 = | |
| 318 | +- Feature: Add line number support | |
| 319 | + | |
| 320 | += 1.6.0 - 2022-09-09 = | |
| 321 | +- Feature: Add additional header styles | |
| 322 | +- Feature: Allow overriding the label in the header | |
| 323 | +- Tweak: Adjust copy button opacity interactions | |
| 324 | + | |
| 325 | += 1.5.2 - 2022-09-08 = | |
| 326 | +- Fix: Fix padding on copy button when padding is disabled | |
| 327 | + | |
| 328 | += 1.5.1 - 2022-09-05 = | |
| 329 | +- Tweak: Allow users to disable padding | |
| 330 | +- Fix: Fixes a bug where the header type set to none doesn't persist | |
| 331 | +- Fix: Clamp font settings were not being persisted | |
| 332 | + | |
| 333 | += 1.5.0 - 2022-09-05 = | |
| 334 | +- Feature: Add toggle so users can clamp font sizes to reasonable values. | |
| 335 | +- Show font styling in theme select sidebar | |
| 336 | + | |
| 337 | += 1.4.0 - 2022-09-04 = | |
| 338 | +- Feature: Add header "window controls" style option | |
| 339 | +- Feature: Add dynamic coding font imports | |
| 340 | +- Feature: Add "recent languages" section to quick switch | |
| 341 | +- Feature: Add alternate way to transform from core block | |
| 342 | + | |
| 343 | += 1.3.0 - 2022-09-04 = | |
| 344 | +- Feature: Add font size controls | |
| 345 | +- Feature: Add Line height controls | |
| 346 | +- Feature: Persist settings in the database instead of localStorage | |
| 347 | +- Fix: Fix overflow editor bug | |
| 348 | + | |
| 349 | += 1.2.8 - 2022-08-31 = | |
| 350 | +- Compatibility: Disable Prismatic. They use an encoding function on all code indiscriminately, breaking this plugin. | |
| 351 | + | |
| 352 | += 1.2.7 - 2022-08-31 = | |
| 353 | +- Fix: Add style overrides for the Hueman theme (and generally good overrides) | |
| 354 | + | |
| 355 | += 1.2.6 - 2022-08-30 = | |
| 356 | +- Fix: Force disable wrapping and overflow for bootstrap based themes. | |
| 357 | + | |
| 358 | += 1.2.5 - 2022-08-30 = | |
| 359 | +- Fix: Force disable wrapping and overflow for some themes. | |
| 360 | + | |
| 361 | += 1.2.4 - 2022-08-30 = | |
| 362 | +- Fix: Limit alignments to wide and full only. | |
| 363 | + | |
| 364 | += 1.2.3 - 2022-08-29 = | |
| 365 | +- Fix: Force left text alignment in the editor | |
| 366 | +- Tweak: Set WP default alignment to "none" | |
| 367 | +- Testing: Add item verification on scroll before click | |
| 368 | + | |
| 369 | += 1.2.2 - 2022-08-28 = | |
| 370 | +- Fix: Zeros out margins on pre elements for better theme compatibility | |
| 371 | + | |
| 372 | += 1.2.1 - 2022-08-27 = | |
| 373 | +- Fix: Remove nested pre tags (changed to div) in editor | |
| 374 | +- Feature: Added test coverage with cypress | |
| 375 | + | |
| 376 | += 1.2.0 - 2022-08-27 = | |
| 377 | +- Feature: Convert code from the core code block | |
| 378 | +- Feature: Convert code from SyntaxHighlighter Evolved | |
| 379 | +- Feature: Add toolbar language select | |
| 380 | +- Feature: Add language "nice names" | |
| 381 | +- Fix: Remove line wrap from frontend | |
| 382 | + | |
| 383 | += 1.1.0 - 2022-08-22 = | |
| 384 | +- Feature: Add filters to hook into output | |
| 385 | +- Tweak: Set copy button on by default | |
| 386 | + | |
| 387 | += 1.0.0 - 2022-08-20 = | |
| 85 | 388 | - Initial release |
