README.md in jekyll_quote-0.4.0 vs README.md in jekyll_quote-0.4.1

- old
+ new

@@ -16,15 +16,55 @@ end ``` And then execute: - $ bundle install + $ bundle +## Syntax +``` +{% quote OPTIONS %} + Content of quote goes here. +{% endquote %} +``` + +The default preposition is 'From'. + +OPTIONS are: + * `break` – Put the citation on a separate line. Ignored if `cite` was not specified. + * `by` – Preface the citation with the preposition 'By'. Ignored if `cite` was not specified. + * `cite` – Citation text + * `class` – Apply additional CSS classes + * `noprep` – Do not preface the citation with a preposition. Ignored if `cite` was not specified. + * `style` – Apply additional CSS styling + * `url` – URL for the citation. Ignored if `cite` was not specified. + + +## Usage Example +``` +{% quote cite="Blaise Pascal, in Lettres provinciales" + url="https://en.wikipedia.org/wiki/Lettres_provinciales" +%} + I have only made this letter longer because + I have not had the time to make it shorter. +{% endquote %} +``` + + ## Attribution See [`jekyll_plugin_support` for `attribution`](https://github.com/mslinn/jekyll_plugin_support#subclass-attribution) + +## Demo +A demo / test website is provided in the `demo` directory. +It can be used to debug the plugin or to run freely. +Please examine the HTML files in the demo to see how the plugin works. + +To run the demo freely from the command line, type: +``` +$ demo/_bin/debug -r +``` ## Additional Information More information is available on [Mike Slinn’s website](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).