I need to embed a code block in a list item in kramdown.
The code block is highlighted by Pygments.
The result looks like the following picture. I expect the code block to shift right to prove it's part of the list element. The kramdown docs use fenced block style, it's not working well with my Jekyll site, so I use another:
{% highlight robotframework %}
...
{% endhighlight %}
How to control the indentation automatically in this manner?
Thanks for any advice.
kramdown supports fenced code block within a list.
According to Planet Jekyll FAQ，The key is to indent your fenced code block lined up with the list item. Also need to put a separating newline above and below the fenced block:
Q: How can I get backtick fenced code blocks (e.g. ```) working inside lists (with kramdown)?
The gist is that the indentation for the code block in lists is determined by the column number of the first non-space character after the list item marker. Huh?
Let's use some examples (note the leading spaces get replaced with dots e.g.
·to help along):Bulleted List
*·some text => use 2 spaces indentation e.g. ``` $ gem install beerdb ``` *···some text => use 4 spaces indentation e.g. ``` $ gem install beerdb ```Numbered List
1.·some text => use 3 spaces indentation e.g. ``` $ gem install beerdb ```==> If you line up the fenced code block with the "natural" list indentation, it will work.
For more examples, see the syntax highlighter sandbox list page - (source).
It appears that Kramdown only supports fenced code blocks at the root (not nested) of the document. While other implementations have recently been adapted to support nested fenced code blocks, Kramdown still implements the old original proposal and has not been updated in some time. If you would like to use fenced code blocks nested within list items, then you will need to use a different Markdown implementation (and/or convince the developers to Kramdown to update their implementation).
You may need to update to a more recent version of Kramdown, and/or adjust the amount of indent that you have in front of each line of your fenced code block. There seems to be some inconsistency in that regard. According to this comment, you should have exactly four spaces of indent, however, at least some versions have been know to fail with four spaces but work with two.
Irrespective of which Markdown implementation you are using Jekyll provides a template based method of identifying code blocks for highlighting purposes. However, that is also restricted to only being on the document root. After all, if you wanted to use a code block within a Markdown document to show how to use this method, that code block would be indented. Therefore, Jekyll only acts on non-indented blocks.
You may find that a JavaScript highlighting engine will serve you better. That way you can use standard (indented) code blocks which will work with any Markdown implementation and nest them however you like. And some of the better JavaScript highlighting engines have pretty good language detection, so you usually don't need to label the language of the code blocks.
