Fenced code in bullet lists with GitHub-flavoured MarkDown??

gistfile1.md

Fenced code blocks inside ordered and unordered lists

1. This is a numbered list.

2. I'm going to include a fenced code block as part of this bullet:

   Code
   More Code
   

3. We can put fenced code blocks inside nested bullets, too.

   1. Like this:

      printf("Hello, World!");

   2. The key is to indent your fenced block by (4 * bullet_indent_level) spaces.

   3. Also need to put a separating newline above and below the fenced block.

---

Failed attempts:

1. This is a bullet.
2. This is the end of the first bullet list, with a fenced code block following:

Code
More Code

3. This is the start of a new bullet list. Hey, where is my fenced code? ``` Code More Code

4. Maybe we can do it with indenting?
    Code
    More Code
5. Did that work? No, so we will try with separation:

    Code
    More Code

6. Now I will try more indenting, to match the bullet margin, plus 4:

       Code
       More Code

7.  Well that was disappointing. How about we indent and use backticks together?
       ```
       Code
       More Code
       ```
8. No such luck.

---

* Oh look, it's some [Apache config](http://pygments.org/docs/lexers/#lexers-for-non-source-code-file-types):

    ```apache
    <Directory /foo/bar>
      Order allow,deny
      Deny from all
    </Directory>
    ```

* Wasn't that fun?

This does not work in GitHub Pages(someuser.github.io), which uses kramdown as the only supported markdown parser.

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).

Wasted 30 mins trying to guess this, you saved me from wasting hours more! Thanks!

Very VERY usefull ! 👍

Can you also add:
4. Also, don't forget to put a space (or 4 spaces for 2nd level) before the number.

Thank you!

Awesome. Thanks for the tip!

+1 would fence code blocks again

you great, unordered lists were problem with code blocks for me, not now.

you saved my sanity. thanks.

+1

Literally scrolled all the way down to say "You rock!" and saw this awesome picture right here at the bottom 🎉

I was searching for this solution for a bit there, thanks much 👍

w00t!

Thanks for posting this!

<3

Thanks. the 4* indent-level number of spaces (with newlines before and after) were the key. Both the Atom editor and Github website are now showing the same format.

Thank you for solving this issue and publishing the results.

Here is one more thank you. 👍

I thinkg they might have fixed this inconsistency and you don't need to fence -- just indent level x 4 spaces. Suddenly, this started working for me:

• Testing
• Testing again

  $ indented code
  

Thank you!

Even after so many years, this gist is giving hope to those of us struggling with markdown!! thank you!!! 😄 🙏

*
    ```
    Block code
    ```
    *
        ```
        Block code
        ```

gives

• Block code
  

  • Block code
    

Demo

Ten years ago and the gift keeps on giving. Thanks 👍

What if I wanna keep the Fenced block code close to the line above.

There are two way to do that.

One is delete the blank line between last item and the block code, but conflict with MD031

Other way is, delete the blank space before back quote `, but then the code is outside of the list.

Is there any solution to do this?

From CommonMark Spec, https://spec.commonmark.org/0.30/#example-254

The most important thing to notice is that the position of the text after the list marker determines how much indentation is needed in subsequent blocks in the list item. If the list marker takes up two spaces of indentation, and there are three spaces between the list marker and the next character other than a space or tab, then blocks must be indented five spaces in order to fall under the list item.

• Check for code in list

  line1  
  ticked `line2`
  quoted "line3"
  

Really helpful !

Altho, a few details of that gist could be updated :

• You don't need to have empty lines around your indented code block if you are using bullet lists
• You can use only 2 space * level instead of 4 if you are using bullet lists

Test

• Line1

  ls

  • Line2

    ls -l

Test
----
- Line1
  ```bash
  ls
  ```
  - Line2
    ```bash
    ls -l
    ```

Wow, I love markdown again!

Still valuable in 2023. Thank you!

Thank you for writing this it has helped me. Hopefully you don't mind, but I'd like to make some suggestions:

1. When you say, The key is to indent your fenced block by (4 * bullet_indent_level) spaces., you should also say this applies to the code within the fenced block. In other words, every line of code in the code block need that same (4 * bullet_indent_level) space prefix.
2. Explicitly point out the Raw button at the upper right of your gist. Clicking on that helped me learn my first bullet point.

This is not a suggestion but it might be interesting to some: technically, you only need (3 * bullet_indent_level) spaces. This is true for any thing you want to include in your bullet point that is written on a different line.