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

Change to kramdown Markdown processor #185

Closed
wcaleb opened this issue Feb 3, 2016 · 5 comments
Closed

Change to kramdown Markdown processor #185

wcaleb opened this issue Feb 3, 2016 · 5 comments
Assignees

Comments

@wcaleb
Copy link
Contributor

wcaleb commented Feb 3, 2016

Apparently GitHub Pages is soon going to disallow redcarpet as a Markdown processor and is requiring that GitHub Pages use kramdown. I need to work on this to see how this will affect us; it likely will change some things such as the way we were styling codeblocks.

@wcaleb wcaleb self-assigned this Feb 3, 2016
@wcaleb
Copy link
Contributor Author

wcaleb commented Feb 3, 2016

@wcaleb
Copy link
Contributor Author

wcaleb commented Feb 23, 2016

Does anyone know of a lesson that has a "table" in it? I'm looking for one to see how the switch to kramdown will affect table syntax.

@acrymble
Copy link

Introduction to the Bash Command Line

On Tue, Feb 23, 2016 at 4:42 PM, W. Caleb McDaniel <notifications@github.com

wrote:

Does anyone know of a lesson that has a "table" in it? I'm looking for one
to see how the switch to kramdown will affect table syntax.


Reply to this email directly or view it on GitHub
#185 (comment)
.

@wcaleb
Copy link
Contributor Author

wcaleb commented Feb 23, 2016

Thanks. Here's a rundown of how the change will affect us, as far as I can tell.

With redcarpet, we were using the with_toc_data extension; kramdown provides same functionality by default without an extension.

With redcarpet, we were using the smart extension to render smart quotes properly; it looks as though kramdown also does this by default.

With redcarpet, we were using the superscript extension so that we could do some rough footnote styling in the Pandoc lesson. But kramdown supports footnotes as part of its feature set. We'll need to bring any footnotes in lessons into conformity with that syntax. I think we will lose the ability to do superscript, but since the only reason we really needed it was footnotes, that may not be a problem.

I think the main reason we were using redcarpet in the first place was to provide fenced code blocks. (See #2.) But the kramdown that GitHub Pages is now using by default now appears to offer that functionality by default.

@wcaleb
Copy link
Contributor Author

wcaleb commented Feb 23, 2016

I've done rough testing of the above changes on the sample lesson at our submissions repo.

@wcaleb wcaleb closed this as completed in 7960b39 Feb 23, 2016
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

No branches or pull requests

2 participants