From 62040d023e030bbe0739bc4c10aff4379ad3cc54 Mon Sep 17 00:00:00 2001 From: Roberto Alsina Date: Tue, 11 Jul 2023 22:25:57 -0300 Subject: [PATCH] README.md --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..027a20e --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Shortcodes + +This is a parser for the shortcode spec as explained in the Hugo docs +and used in Hugo and Nikola. Approximately. + +I am implementing this for Nicolino. + +It probably won't be 100% identical, but I'll try to make it +as close as practical. + +* Implemented in Ragel + C for performance +* Allocates no memory, because all strings are references to + pieces of input. + +What works: + +* Detect shortcodes with names +* Standalone and matched shortcodes +* Capture data between tags in matched shortcodes +* Capture arguments with and without names +* Capture values with and without quotes (with details, see TODO above) +