Skip to content
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

Merged
merged 8 commits into from
Apr 10, 2017
Merged

Conversation

GeoffreyBooth
Copy link
Collaborator

@GeoffreyBooth GeoffreyBooth commented Apr 9, 2017

https://rawgit.com/GeoffreyBooth/coffeescript/2.0.0-beta1-docs/docs/v2/index.html

I’ve updated the 2 docs to reflect:

I’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/

@GeoffreyBooth GeoffreyBooth added this to the 2.0.0 milestone Apr 9, 2017
@GeoffreyBooth GeoffreyBooth mentioned this pull request Apr 9, 2017
Copy link
Collaborator

@lydell lydell left a 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
Copy link
Collaborator

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.

Copy link
Collaborator Author

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.

@GeoffreyBooth GeoffreyBooth merged commit d20f549 into jashkenas:2 Apr 10, 2017
@lydell lydell deleted the 2.0.0-beta1-docs branch April 10, 2017 06:45
@GeoffreyBooth
Copy link
Collaborator Author

So . . . release beta1 now (or rather, after I merge the 1.12.5 master fixes into it), or wait until #4493 is ready?

@GeoffreyBooth GeoffreyBooth mentioned this pull request Apr 13, 2017
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