Merge pull request #3834 from vespa-engine/vadim/toc-comments-parsing-fix

Excluding commented section's headings from TOC

Author: kkraune

_includes/toc.html

@@ -1,18 +1,37 @@
 <!-- Copyright Vespa.ai. All rights reserved. -->
 {% assign h2_count = content | split: '<h' | size | minus: 1 %}
     {% if h2_count > 4 %}
-  
+
 
 <nav class="toc {% if page.title == 'FAQ - frequently asked questions'%} faq-toc {% endif %}" aria-labelledby="on-this-page-heading" style="position: fixed; align-self: flex-start;">
     <h3 id="on-this-page-heading"  style="pointer-events: none;">On this page:</h3>
     {% assign headings = content | split: '<' %}
 
     <ul>
           {% for tag in headings %}
-          {% assign tag_slice = tag | slice: 0, 1%}
-          {% if tag_slice == '/' %}
+          {% assign trimmed_tag = tag | strip %}
+          {% assign tag_slice = trimmed_tag | slice: 0, 3 %}
+
+          <!-- skip if parser is inside of comment tag -->
+          {% if tag_slice == '!--' %}
+            {% assign skip = true %}
+          {% endif %}
+          <!-- stop skiping if parser reached comment tag end -->
+          {% if tag contains '-->' %}
+            {% assign skip = false %}
             {% continue %}
-          {% else %}
+          {% endif %}
+    
+          {% if skip %}
+            {% continue %}
+          {% endif %}
+          
+          
+          {% assign first_char = trimmed_tag | slice: 0, 1 %}
+          {% if first_char == '/' %}
+            {% continue %}
+          {% endif %}
+        
           {% assign tag_start = tag | slice: 0, 3 %}
           {% if tag_start == 'h1 ' or tag_start == 'h2 ' or tag_start == 'h3 ' or tag_start == 'h1>' or tag_start == 'h2>' or tag_start == 'h3>' %}          
               {% assign toc_level = tag | slice: 1, 2%}
@@ -26,13 +45,11 @@ <h3 id="on-this-page-heading"  style="pointer-events: none;">On this page:</h3>
               <li class="toc-level-{{toc_level | minus: 1 }}">
                 <a href="#{{ heading_id }}">{{ heading_text }}</a>
               </li>
-          {% endif %}
-            {% endif %}
+              {% endif %}
           {% endif %}
           {% endfor %}
 
     </ul>
   </div>
 
-{% endif %}
-  
+{% endif %}