Anshorei
/
squib
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Some tweaks to the README 

[skip ci]
dev
Andy Meneely 2015-04-11 11:04:01 -04:00
parent 0e22c52b0f
commit 7360c8f550
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -250,10 +250,13 @@ If you want to do specialized formatting within a given string, Squib has lots o
* Apostraphes are converted to curly as well.
* LaTeX-style quotes are explicitly converted (<tt>``like this''</tt>)
* Em-dash and en-dash are converted with triple and double-dashes respectively (<tt>--</tt> is an en-dash, and <tt>---</tt> becomes an em-dash.)
* Ellipses can be specified with <tt>...</tt>. Note that this is entirely different from the `ellipsize` option, which is determining what to do with overflowing text.
* Ellipses can be specified with <tt>...</tt>. Note that this is entirely different from the `ellipsize` option (which determines 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`
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. `&amp;` for `&')
### Text Sample
```yaml
lsquote: "\u2018" #note that Yaml wants double quotes here to use escape chars
rsquote: "\u2019"