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 Quickstart re: kramdown default #2387

Merged
merged 2 commits into from May 12, 2014

Conversation

Projects
None yet
5 participants
@jaybe-jekyll
Member

jaybe-jekyll commented May 11, 2014

Update Quickstart documentation to reflect Jekyll’ 2.0 default of
kramdown Markdown engine versus Redcarpet.

jaybe@jekyll
Update Quickstart re: kramdown default
Update Quickstart documentation to reflect Jekyll’ 2.0 default of
kramdown Markdown engine versus Redcarpet.
@parkr

View changes

site/docs/quickstart.md Outdated
<h5>Redcarpet is the default Markdown engine for new sites</h5>
<p>In Jekyll 1.1, we switched the default markdown engine for sites
generated with <code>jekyll new</code> to Redcarpet</p>
<h5>kramdown is the default Markdown engine for new sites</h5>

This comment has been minimized.

@parkr

parkr May 11, 2014

Member

No capitals? :)

This comment has been minimized.

@jaybe-jekyll

jaybe-jekyll May 11, 2014

Member

Correct, with respect to the kramdown project. :)

kramdown (sic, not Kramdown or KramDown, just kramdown) is a free MIT-licensed Ruby library for parsing and converting a superset of Markdown. It is completely written in Ruby, supports standard Markdown (with some minor modifications) and various extensions that have been made popular by the PHP Markdown Extra package and Maruku.

http://kramdown.gettalong.org

This comment has been minimized.

@parkr

parkr May 11, 2014

Member

Can you encase it in <code> then? It feels so weird to start a sentence without a capital letter!

This comment has been minimized.

@kleinfreund

kleinfreund May 11, 2014

Contributor

In my opinion, beginning a sentence with a capital letter is the right thing to do here, although the original name is lower case. It feels weird indeed.

However I'm not sure. Can someone clarify that?

This comment has been minimized.

@mscharley

mscharley May 11, 2014

Contributor

Throwing it in a code block would resolve the issue assuming it has some
styling. It is weird because English doesn't really have any cases in it
where there are forced lowercase letters. I'd go with whatever precedent is
set by the project authors if we don't want the code block, I'm sure
they've had to start sentences with it as well.

On 12 May 2014 05:54, Philipp Rudloff notifications@github.com wrote:

In site/docs/quickstart.md:

@@ -21,9 +21,9 @@ posts, using the front-matter to control templates and layouts, and taking
advantage of all the awesome configuration options Jekyll makes available.

-
Redcarpet is the default Markdown engine for new sites
-

In Jekyll 1.1, we switched the default markdown engine for sites - generated with jekyll new to Redcarpet

-
kramdown is the default Markdown engine for new sites

In my opinion, beginning a sentence with a capital letter is the right
thing to do here, although the original name is lower case. It feels weird
indeed.

However I'm not sure. Can someone clarify that?


Reply to this email directly or view it on GitHubhttps://github.com//pull/2387/files#r12510427
.

This comment has been minimized.

@kleinfreund

kleinfreund May 11, 2014

Contributor

So you know how it'll look like:

kramdown

This comment has been minimized.

@parkr

parkr May 11, 2014

Member

How about this:

The default markdown engine for new sites is kramdown.

Or, we can just get rid of this. It's not necessary now that the default and the default for new sites is the same.

This comment has been minimized.

@kleinfreund

kleinfreund May 11, 2014

Contributor

Actually, getting rid of it doesn't sound bad. The information is still available in the defaults. Is there another purpose we're missing?

This comment has been minimized.

@mscharley

mscharley May 11, 2014

Contributor

If the original purpose was to explain the difference between the default
and the default for jekyll new then I'd say it's probably obsolete now.

On 12 May 2014 07:28, Philipp Rudloff notifications@github.com wrote:

In site/docs/quickstart.md:

@@ -21,9 +21,9 @@ posts, using the front-matter to control templates and layouts, and taking
advantage of all the awesome configuration options Jekyll makes available.

-
Redcarpet is the default Markdown engine for new sites
-

In Jekyll 1.1, we switched the default markdown engine for sites - generated with jekyll new to Redcarpet

-
kramdown is the default Markdown engine for new sites

Actually, getting rid of it doesn't sound bad. The information is still
available in the defaults. Is there another purpose we're missing?


Reply to this email directly or view it on GitHubhttps://github.com//pull/2387/files#r12510848
.

This comment has been minimized.

@parkr

parkr May 11, 2014

Member

👍

@jaybe-jekyll

This comment has been minimized.

Member

jaybe-jekyll commented May 12, 2014

It pleases me to see such care, attention, and responses to a capitalization discussion within the Jekyll docs. :)

So it appears the blessed solution is to remove the default Markdown engine section as it is redundant and unnecessary. I will proceed with doing so and resubmit.

Aside, I wanted to reply to @kleinfreund and suggest a legitimate and reasonable way of handling the situation would indeed to have been to take the liberty of capitalizing kramdown at the beginning of the sentence.

jaybe@jekyll
Remove Quickstart' Default Markdown Section
Remove default Markdown section from Quickstart documentation page as
it is redundant and unnecessary at this time. #2387

parkr added a commit that referenced this pull request May 12, 2014

@parkr parkr merged commit e7b8123 into jekyll:master May 12, 2014

1 check was pending

continuous-integration/travis-ci The Travis CI build is in progress
Details

parkr added a commit that referenced this pull request May 12, 2014

@jaybe-jekyll jaybe-jekyll deleted the jaybe-jekyll:doc_updates branch May 12, 2014

@parkr

This comment has been minimized.

Member

parkr commented May 12, 2014

Thank you, @jaybe-jekyll! :)

@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.