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.
- 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)
- UTF-8 strings AFAICT (arg and shortcode names only support ascii tho)
You need Ragel and a C compiler.
Ragel is used to generate shortcodes.c
out of shortcodes.rl
.
As a convenience there is a generated shortcodes.c
in the repo,
Then:
cd src && make
To run tests:
crystal spec
-
Add the dependency to your
shard.yml
:dependencies: shortcodes: github: ralsina/shortcodes
-
Run
shards install
require "shortcodes"
Just copy shortcodes.c
and shortcodes.h
into your project and have fun.