From 15bba8a9df70f1cf228ca57479f399905ed1f2fa Mon Sep 17 00:00:00 2001 From: Brent Schroeter Date: Sun, 25 Jan 2026 23:35:05 +0000 Subject: [PATCH] update documentation --- README.md | 12 ++++++++++++ block-diagram.svg | 4 ++++ package.json | 1 + 3 files changed, 17 insertions(+) create mode 100644 block-diagram.svg diff --git a/README.md b/README.md index e52edd7..7238958 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,10 @@ export default function (eleventyConfig) { [Themes included with Giallo](https://github.com/getzola/giallo/blob/master/README.md#themes) +## Block Diagram + +![block diagram of plugin architecture](./block-diagram.svg) + ## Development Quickstart [Mise-en-place](https://mise.jdx.dev/) manages dev dependencies and scripts. @@ -48,3 +52,11 @@ mise run test global Javascript function. - Line highlights and numbers are not yet supported. - Giallo does not support Prism-style diff format. + +## Licensing + +`11ty-plugin-giallo` is distributed under the European Union Public License v. +1.2, to match the licensing of the Giallo crate. The EUPL is generally +compatible with other OSI-approved copyleft licenses; for more information refer +to the +[compatibility matrix](https://interoperable-europe.ec.europa.eu/collection/eupl/matrix-eupl-compatible-open-source-licences). diff --git a/block-diagram.svg b/block-diagram.svg new file mode 100644 index 0000000..a7d8b11 --- /dev/null +++ b/block-diagram.svg @@ -0,0 +1,4 @@ + + +WebAssembly Component:brentsch:giallo-jslib.rs(wit-bindgen boilerplate)WebAssemblyInterface Type(WIT) definitionsjcoRust Crate:giallogiallo dependencies(Rust and C libs)giallo dependencies(Rust and C libs)giallo dependencies(Rust and C libs)JavascriptBindingsEleventy PluginEntrypointEleventyWebAssembly Components:wasi:*NPM Package: 11ty-plugin-giallolinked tocalled byshims forcalled bycalled bydepended ongeneratesdepended oncompiles toprovided toprovided toPackaging a RustPlugin for Eleventy \ No newline at end of file diff --git a/package.json b/package.json index 18bb9be..4ada19a 100644 --- a/package.json +++ b/package.json @@ -2,6 +2,7 @@ "name": "11ty-plugin-giallo", "version": "0.1.0-beta.0", "description": "Eleventy plugin to support TextMate-style syntax highlighting via the Giallo Rust crate.", + "keywords": ["eleventy", "eleventy-plugin"], "repository": { "type": "git", "url": "https://forge.secondsystemtech.com/brent/11ty-plugin-giallo"