Skip to content
This repository has been archived by the owner on Oct 9, 2018. It is now read-only.

Fixes #6579 - Fixing code blocks in our documentation #21

Merged
merged 1 commit into from Jul 14, 2014

Conversation

daviddavis
Copy link
Contributor

TL;DR: kramdown doesn't support ``` language syntax blocks so we have to use ~~~ instead. Alternatively, we could switch back to redcarpet for markdown rendering.

@waldenraines
Copy link
Contributor

Why are we using this more verbose syntax? What does it provide other than non-formatted blocks on github 😄?

@daviddavis
Copy link
Contributor Author

@waldenraines this is what I see with the backticks:

screen shot 2014-07-10 at 9 40 58 pm

While fixed syntax:

screen shot 2014-07-10 at 9 40 40 pm

@daviddavis
Copy link
Contributor Author

Is this maybe due to redcarpet vs kramdown?

@waldenraines
Copy link
Contributor

@daviddavis
Copy link
Contributor Author

@waldenraines yea, I know. Github doesn't render liquid which is what jekyll is using.

@daviddavis
Copy link
Contributor Author

@waldenraines updated. Apparently kramdown uses ~~~ for codeblocks which github does support. I'm still debating a little bit about switching back to redcarpet so we can use ``` as that's pretty standard. The only thing is that redcarpet doesn't use pretty ids. Thoughts?

/cc @ehelms

@waldenraines
Copy link
Contributor

See also vmg/redcarpet#52

@ehelms
Copy link
Member

ehelms commented Jul 14, 2014

@daviddavis to keep the ``` syntax just add:

kramdown:
  input: GFM

Ref: http://jekyllrb.com/docs/configuration/#kramdown
http://kramdown.gettalong.org/parser/gfm.html

@daviddavis
Copy link
Contributor Author

@ehelms good find. Updated.

@ehelms
Copy link
Member

ehelms commented Jul 14, 2014

ACK

daviddavis pushed a commit that referenced this pull request Jul 14, 2014
Fixes #6579 - Fixing code blocks in our documentation
@daviddavis daviddavis merged commit 11957fa into Katello:master Jul 14, 2014
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants