Skip to content

Conversation

@kemitchell
Copy link

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
Copy link
Contributor

anseljh commented May 2, 2015

👍

I had to do this in my own fork too when I was using Series Seed docs in a document automation project: anseljh@beda29c and anseljh@2b35eb0

@kemitchell
Copy link
Author

Thanks, @anseljh!

@kemitchell
Copy link
Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants