New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update curly apostrophes in documentation #1419

Merged
merged 1 commit into from Aug 14, 2013

Conversation

Projects
None yet
4 participants
@doktorbro
Member

doktorbro commented Aug 13, 2013

Jekyll doesn’t always transform straight apostrophes into curly ones. The transformation seems to work in posts, but not always in pages. It’s more reliable to type the curly apostrophes by hand.

@mattr-

This comment has been minimized.

Member

mattr- commented Aug 14, 2013

Thanks for the update! Jekyll doesn't automatically converts these. 😃

mattr- added a commit that referenced this pull request Aug 14, 2013

Merge pull request #1419 from penibelst/typo-apostrophe
Update curly apostrophes in documentation

@mattr- mattr- merged commit cb95e25 into jekyll:master Aug 14, 2013

1 check passed

default The Travis CI build passed
Details

mattr- added a commit that referenced this pull request Aug 14, 2013

@parkr

This comment has been minimized.

Member

parkr commented Aug 14, 2013

Wait, am I missing something? What is the purpose of these special apostrophes?

@mattr-

This comment has been minimized.

Member

mattr- commented Aug 14, 2013

Gotta keep the docs classy. 😃

On Tue, Aug 13, 2013 at 8:35 PM, Parker Moore notifications@github.comwrote:

Wait, am I missing something? What is the purpose of these special
apostrophes?


Reply to this email directly or view it on GitHubhttps://github.com//pull/1419#issuecomment-22609955
.

@parkr

This comment has been minimized.

Member

parkr commented Aug 14, 2013

Hemingway would be proud?

@doktorbro doktorbro deleted the doktorbro:typo-apostrophe branch Aug 14, 2013

@doktorbro

This comment has been minimized.

Member

doktorbro commented Aug 14, 2013

Jekyll doesn't automatically converts these.

This is not true. Jekyll’s current markdown engine does convert these. Compare:

It works in posts. I don’t know why it doesn’t work everywhere else.

Wait, am I missing something? What is the purpose of these special apostrophes?

They are not special. The curly one is the right typographic form of the apostrophe. The doc sources was already full of curly apostrophes before my update, look at the source of Writing posts.

Bad kerning

Image source

@mattr-

This comment has been minimized.

Member

mattr- commented Aug 14, 2013

Jekyll only hands it off to the Markdown/Textile engine in use. Jekyll
supports four different Markdown rendering engines and the behavior may not
be the same between each one. I know for a fact that Redcarpet (because I
help maintain it) doesn't do any conversion, for example.

On Wed, Aug 14, 2013 at 3:26 AM, Anatol Broder notifications@github.comwrote:

Jekyll doesn't automatically converts these.

This is not true. Jekyll’s current markdown engine does convert these.
Compare:

  • sourcehttps://github.com/mojombo/jekyll/blob/gh-pages/_posts/2013-07-24-jekyll-1-1-1-released.markdownwith straight apostrophes;
  • destinationhttp://jekyllrb.com/news/2013/07/24/jekyll-1-1-1-released/with curly apostrophes.

It works in posts. I don’t know why it doesn’t work everywhere else.

Wait, am I missing something? What is the purpose of these special
apostrophes?

They are not special. The curly one is the right typographic formhttp://en.wikipedia.org/wiki/Apostrophe#Typographic_formof the apostrophe. The doc sources was already full of curly apostrophes
before my update, look at the source of *Writing postshttps://github.com/mojombo/jekyll/blob/gh-pages/docs/posts.md
*.

[image: Bad kerning]https://github-camo.global.ssl.fastly.net/30ffc7b8f9b064abeabcae7a47e1abe7bd3d13b5/687474703a2f2f696d67732e786b63642e636f6d2f636f6d6963732f6b65726e696e672e706e67

Image source http://xkcd.com/1015/


Reply to this email directly or view it on GitHubhttps://github.com//pull/1419#issuecomment-22621369
.

@doktorbro

This comment has been minimized.

Member

doktorbro commented Aug 14, 2013

@mattr- Sorry for the ambiguous parlance, I mean the markdown engine that is used on Jekyll’s official site. It’s not set in config.yml, so it must be Jekyll’s default kramdown: maruku. Right?

Maruku transforms wrong apostrophes, wrong quotes and wrong dashes --- into right ones. This is my test sentence:

Jekyll's promise: "No more databases, comment moderation, or pesky updates to install---just your content."

The result is:

Jekyll’s promise: “No more databases, comment moderation, or pesky updates to install—just your content.”

This is pretty nice, at least for English writers. If I set markdown: redcarpet, nothing happens.

Is the little typographical helper something Jekyll wants to promote as a feature? Should anybody mention it in the documentation? New ticket?

@mattr-

This comment has been minimized.

Member

mattr- commented Aug 14, 2013

I'm not really interested in promoting this for several reasons:

 - there are bugs in maruku that require people to replace it with another engine, which leads to the next point.
 - it's semi-deprecated, as we recommend new sites use redcarpet and sites generated with  jekyll new enforce that recommendation.

On Wed, Aug 14, 2013 at 4:14 PM, Anatol Broder notifications@github.com
wrote:

@mattr- Sorry for the ambiguous parlance, I mean the markdown engine that is used on Jekyll’s official site. It’s not set in config.yml, so it must be Jekyll’s default kramdown: maruku. Right?
Maruku transforms wrong apostrophes, wrong quotes and wrong dashes --- into right ones. This is my test sentence:

Jekyll's promise: "No more databases, comment moderation, or pesky updates to install---just your content."

The result is:

Jekyll’s promise: “No more databases, comment moderation, or pesky updates to install—just your content.”

This is pretty nice, at least for English writers. If I set markdown: redcarpet, nothing happens.

Is the little typographical helper something Jekyll wants to promote as a feature? Should anybody mention it in the documentation? New ticket?

Reply to this email directly or view it on GitHub:
#1419 (comment)

@doktorbro

This comment has been minimized.

Member

doktorbro commented Aug 15, 2013

Thank you for clarification.

@parkr

This comment has been minimized.

Member

parkr commented Aug 15, 2013

The typographic conventions are helpful for writing prose, but I have had a hell of a time trying to make sure --option isn't converted into –option.

@doktorbro

This comment has been minimized.

Member

doktorbro commented Aug 15, 2013

Sure, such transformations don’t make sense inside of code or pre tags.

@jekyll jekyll locked and limited conversation to collaborators Feb 27, 2017

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