Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Feature/typography #59

Closed
wants to merge 2 commits into from

3 participants

@Zearin

• Smart quotes (except in code!)
• Fixed a few typos I stumbled across while searching for quotes (e.g., replaced “lets” with “let’s” when appropriate; “dont't” with “don’t”, etc.)

Devs are usually afraid of using automatic smart-quotes, because it messes up code.

I manually converted smart-quotes and dashes just in the main body text. This should improve legibility, make the articles seem more professional, and improve contrast between code and body text.

Zearin added some commits
Zearin Added em-dashes where appropriate.
Em-dashes are for pauses in body text—like this.
2390301
Zearin Various typographical edits.
• Smart quotes (except in code!)
• Fixed a few typos I stumbled across while searching for quotes (e.g., replaced “lets” with “let’s” when appropriate; “dont't” with “don’t”, etc.)
93fd02b
@Zearin

Forgot to mention: I limited my work to markdown files. ☺

@Zearin

ping

@kriskowal kriskowal commented on the diff
articles/bogart-couchdb.markdown
@@ -35,7 +35,7 @@ Bogart is in the npm registry.
[CouchDB](http://couchdb.apache.org) is a document-oriented database with
a RESTful interface. CouchDB works well with JavaScript since CouchDB speaks JSON.
-Also, CouchDB is queried using 'views' that are, by default, written in JavaScript.
+Also, CouchDB is queried using views that are, by default, written in JavaScript.
@kriskowal Collaborator

It looks like you did a global replace of all straight single quotes to apostrophes. This is one case where it might be better to switch these with matched single or double quotes.

@Zearin
Zearin added a note

Those actually are matched single-quotes. :) I think it’s just an oddity of whatever monospace font Github is using.

Try copy-pasting it into somewhere with another font. You’ll see…all is well.

@kriskowal Collaborator

That’s funny. Thanks.

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

It might be better to automate this in Markdown or Wheat, since it would be onerous for new article writers to use directional quotes and apostrophes manually.

@Zearin

Maybe. But in defense of what I’ve got here:

  • Automation never gets everything 100% right. Edge cases for this are tough, but surprisingly common.
  • I’m obsessive about this stuff :) As long as this doesn’t seem like a dead project, I’ll check back in from time to time and fix anything missing
  • In the meantime, this should have converted most of the articles.

What say you?

@kriskowal
Collaborator

@zearin Sounds good to me if you’re taking responsibility for it. Of course, @creationix has the only vote. I could never say “no” to more help. Apart from the one mistake I posted inline, which I got from a cursory glance, the merge is not clean, so you might give it another once-over. I would scan for occurrences of apostrophes that appear at the beginnings of words. That is only really appropriate for “’twas”.

@creationix
Owner

I always liked how some markdowns would auto-convert quotes and dashes in prose. Then the author can continue to write the markdown in ascii, but it's displayed using proper characters. Would this be sufficient? I'd rather not require all future authors to start using unicode to type the content.

@Zearin

Hi! I’m back. Reviewing my outstanding Pull Requests. :)

I always liked how some markdowns would auto-convert quotes and dashes in prose. Then the author can continue to write the markdown in ascii, but it's displayed using proper characters. Would this be sufficient?

Many people find that useful. Personally, I’ve never trusted those systems; there are always cases of false positives and false negatives in identifying which quotation marks to convert.

On OS X:

  • There’s an auto-smartquote feature that does a half-decent job. I usually turn it off, because it interferes with writing code examples.
  • Fortunately, ⇧⌥[ and ⇧⌥] do the smartquotes, and after I discovered the shortcut it took me almost no time to use it automatically (and only as-needed).

I'd rather not require all future authors to start using unicode to type the content.

It looks like the publishing of new articles on howtonode.org has slowed. I think that means that most future work will be maintenance-type work, or cosmetic facelifts and the like. The article content itself won’t really suffer.

@zearin Sounds good to me if you’re taking responsibility for it.

I can do that.

@Zearin

Closing due to lack of interest.

@Zearin Zearin closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Jan 25, 2012
  1. Added em-dashes where appropriate.

    Zearin authored
    Em-dashes are for pauses in body text—like this.
  2. Various typographical edits.

    Zearin authored
    • Smart quotes (except in code!)
    • Fixed a few typos I stumbled across while searching for quotes (e.g., replaced “lets” with “let’s” when appropriate; “dont't” with “don’t”, etc.)
Something went wrong with that request. Please try again.