Skip to content

Latest commit

 

History

History
22 lines (16 loc) · 1017 Bytes

README.md

File metadata and controls

22 lines (16 loc) · 1017 Bytes
Raw

Pikchr Block

This Gutenberg block renders Pikchr code to SVG.

Like the markdown block there are security considerations with allowing SVG to be embedded in a post, so this block will only work when the current user has the unfiltered_html capability. This is generally just admins of the site.

The Pikchr code is rendered using a WASM compiled version of the C library. The source for the C library is included in this repo, for the purposes of recompilation, and includes the Zero-Clause BSD license. Please see the Pikchr site for any further information.

Installation

  • Clone the repository (if using an existing WordPress installation do this into your plugins directory)
  • npm install
  • Optionally start a WordPress environment with npm wp-env start
  • npm build or npm start depending on whether you would like a production build or develop the code respectively.
  • Ensure the plugin is activated.
  • Edit a post, and insert the Pikchr block.