search

seriesseed / equity

Series Seed Preferred Stock
http://www.seriesseed.com
1.23k stars 334 forks source link

Use Only ASCII Characters #38

Open kemitchell opened 9 years ago

kemitchell commented 9 years ago

This patch replaces typographers' quotation marks and other hard-to-type characters with their keyboard-key equivalents. These easier-to-type characters are part of the standard ASCII set of computer characters.

The documents currently use some of both, leading to inconsistent looking documents and difficulty searching out definitions. Consistency also makes it possible for tools designed to work with Markdown, like pandoc, to decide whether to "educate" straight quotes, depending on the kind of output desired.

In the case of a few bullet points in RELEASENOTES, using ASCII characters actually helps Markdown determine that it should display a list, rather than a series of paragraphs that start with bullet characters.

anseljh commented 9 years ago

:thumbsup:

I had to do this in my own fork too when I was using Series Seed docs in a document automation project: https://github.com/anseljh/equity/commit/beda29c95724b700cfdfe34936cea073c403313f and https://github.com/anseljh/equity/commit/2b35eb035669a750d5acf243ea52fcdfefcbc4d3

kemitchell commented 9 years ago

Thanks, @anseljh!

kemitchell commented 9 years ago

For the record, this PR is related to #32, where I've just added a commit that uses pandoc's --smart option to ensure ASCII punctuation is converted to more attractive "curly quotes" and long dashes automatically.