README.md

This commit is contained in:
Roberto Alsina 2023-07-11 22:25:57 -03:00
parent fa27e12e59
commit 62040d023e

22
README.md Normal file
View File

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