update documentation

This commit is contained in:
Brent Schroeter 2026-01-25 23:35:05 +00:00
parent d37f346793
commit 15bba8a9df
3 changed files with 17 additions and 0 deletions

View file

@ -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).

4
block-diagram.svg Normal file

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 46 KiB

View file

@ -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"