Exception on comments with # prefix in code blocks

[GjjvdBurg]

Hi!

Thanks for making this package! I just tried to use it but unfortunately ran into a bug when a line contains a # symbol in a code block. Here's a minimal example:

# Header

```python
# look a comment!
#

(ran into an issue with markdown-in-markdown here, so couldn't close the python block, but I hope you get the idea).

The first line in the code block is interpreted as a header and the second line causes the GithubEmptyLinkLabel exception to be raised. Both are undesired behavior I think. Thanks!

[frnmst]

Thank you

Yes I am aware of this bug. I need to add a check that tells the parser to ignore everything between code blocks. I hope to come up with something, soon.

[GjjvdBurg]

I haven't tested this extensively, but this works for my example above:

diff --git a/md_toc/api.py b/md_toc/api.py
index 646aa45..ce99762 100644
--- a/md_toc/api.py
+++ b/md_toc/api.py
@@ -99,9 +99,16 @@ def build_toc(filename,
     toc = ''
     header_duplicate_counter = dict()
 
+    in_code = False
+
     with open(filename, 'r') as f:
         line = f.readline()
         while line:
+            if line.strip().startswith("```"):
+                in_code = not in_code
+            if in_code:
+                line = f.readline()
+                continue
             header = get_md_header(line, header_duplicate_counter,
                                    keep_header_levels, parser, no_links)
             if header is not None:

[frnmst]

Thanks a lot.

I will add your fix along with the unit tests in the next release. I will keep this issue open in the meantime.

See also:

• https://github.com/frnmst/todo/blob/master/todo/md-toc.md
• https://github.com/frnmst/md-toc/tree/dev

[GjjvdBurg]

Great, thanks for making this tool!

[frnmst]

Hello again,

for the moment I found these:

• https://github.github.com/gfm/#code-fence
• https://github.com/vmg/redcarpet/blob/26c80f05e774b31cd01255b0fa62e883ac185bf3/ext/redcarpet/markdown.c#L1389

and I'll have to follow these specs to the letter. See also: https://frnmst.github.io/md-toc/markdown_specification.html

[frnmst]

See https://github.com/frnmst/md-toc/projects/1

[frnmst]

Done for github,cmark,gitlab,commonmarker. Missing redcarpet.