-
Notifications
You must be signed in to change notification settings - Fork 2k
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
[CS2] 2.0.0-beta1 docs #4494
[CS2] 2.0.0-beta1 docs #4494
Conversation
…wn tables, avoid hack of blockquoted code blocks
…s variant for comments font
…aking Changes section below Literate CoffeeScript section
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just one little note. Not sure if it makes a difference.
Cakefile
Outdated
try | ||
return hljs.highlight(lang, str).value | ||
catch ex | ||
return '' # No syntax highlighting |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line should be dedented once according to the documentation you linked to.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch! Probably didn’t matter because highlight.js never threw an exception, but can’t hurt to get it right.
So . . . release beta1 now (or rather, after I merge the 1.12.5 |
https://rawgit.com/GeoffreyBooth/coffeescript/2.0.0-beta1-docs/docs/v2/index.html
I’ve updated the 2 docs to reflect:
get
orset
keywords or function calls #4484: Throw and error on ambiguousget
orset
function callsI’ve removed Marked in favor of Markdown-It, so now we only have one Markdown parsing library across the project for both documentation and Literate CoffeeScript support. I also added syntax highlighting back in for the non-editable code blocks.
The release date for 2.0.0-beta1 is a wild guess that I expect we’ll revise as part of that actual release; I just thought these changes, especially the Markdown library swap, were significant enough to warrant their own PR and review.
On a side note, should we release beta1 now or wait for #4493 to land?
Preview of docs in this PR: https://rawgit.com/GeoffreyBooth/coffeescript/2.0.0-beta1/docs/v2/