From 7360c8f550d879d48fc68a9e744074a88df56cb9 Mon Sep 17 00:00:00 2001 From: Andy Meneely Date: Sat, 11 Apr 2015 11:04:01 -0400 Subject: [PATCH] Some tweaks to the README [skip ci] --- README.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index dfa5d37..3a045ee 100644 --- a/README.md +++ b/README.md @@ -245,15 +245,18 @@ end If you want to do specialized formatting within a given string, Squib has lots of options. By setting `markup: true`, you enable tons of text processing. This includes: -* Pango Markup. This is an HTML-like formatting language that specifies formatting inside your string. Pango Markup essentially supports any formatting option, but on a letter-by-letter basis. Such as: font options, letter spacing, gravity, color, etc. See the [Pango docs](https://developer.gnome.org/pango/stable/PangoMarkupFormat.html) for details. -* Quotes are converted to their curly counterparts where appropriate (i.e. “smart quotes” instead of "straight quotes"). -* Apostraphes are converted to curly as well. -* LaTeX-style quotes are explicitly converted (``like this'') -* Em-dash and en-dash are converted with triple and double-dashes respectively (-- is an en-dash, and --- becomes an em-dash.) -* Ellipses can be specified with .... Note that this is entirely different from the `ellipsize` option, which is determining what to do with overflowing text. - -The above replacements assume you are using the UTF-8 character set. If you wish to change the characters, set the following configuration options in your `config.yml` - + * Pango Markup. This is an HTML-like formatting language that specifies formatting inside your string. Pango Markup essentially supports any formatting option, but on a letter-by-letter basis. Such as: font options, letter spacing, gravity, color, etc. See the [Pango docs](https://developer.gnome.org/pango/stable/PangoMarkupFormat.html) for details. + * Quotes are converted to their curly counterparts where appropriate (i.e. “smart quotes” instead of "straight quotes"). + * Apostraphes are converted to curly as well. + * LaTeX-style quotes are explicitly converted (``like this'') + * Em-dash and en-dash are converted with triple and double-dashes respectively (-- is an en-dash, and --- becomes an em-dash.) + * Ellipses can be specified with .... Note that this is entirely different from the `ellipsize` option (which determines what to do with overflowing text). + +A few notes: + * Smart quoting assumes the UTF-8 character set. + * Pango markup uses an XML/HTML-ish processor. Some characters require HTML-entity escaping (e.g. `&` for `&') + +### Text Sample ```yaml lsquote: "\u2018" #note that Yaml wants double quotes here to use escape chars rsquote: "\u2019"