vdoc: fix markdown lists in html (#21287)

vlang · Apr 15, 2024 · e387fcb · e387fcb
1 parent e676245
commit e387fcb
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 5 deletions.
diff --git a/cmd/tools/vdoc/html.v b/cmd/tools/vdoc/html.v
@@ -511,13 +511,21 @@ fn doc_node_html(dn doc.DocNode, link string, head bool, include_examples bool,
 		readme_lines := dn.comments[0].text.split_into_lines()
 		mut merged_lines := []string{}
 		mut is_codeblock := false
-		for i := 0; i < readme_lines.len - 1; i++ {
+		for i := 0; i < readme_lines.len; i++ {
 			l := readme_lines[i]
-			nl := readme_lines[i + 1]
-			if l.trim_left('\x01').trim_space().starts_with('```') {
+			nl := readme_lines[i + 1] or {
+				merged_lines << l
+				break
+			}
+			l_trimmed := l.trim_left('\x01').trim_space()
+			if l_trimmed.starts_with('```') {
 				is_codeblock = !is_codeblock
 			}
-			if !is_codeblock && l != '' && nl != ''
+			// -> if l_trimmed.len > 1 && (is_ul || is_ol)
+			is_list := l_trimmed.len > 1 && ((l_trimmed[1] == ` ` && l_trimmed[0] in [`*`, `-`])
+				|| (l_trimmed.len > 2 && l_trimmed[2] == ` ` && l_trimmed[1] == `.`
+				&& l_trimmed[0].is_digit()))
+			if !is_codeblock && l != '' && nl != '' && !is_list
 				&& !nl.trim_left('\x01').trim_space().starts_with('```') {
 				merged_lines << '${l} ${nl}'
 				i++

diff --git a/cmd/tools/vdoc/tests/testdata/output_formats/README.md b/cmd/tools/vdoc/tests/testdata/output_formats/README.md
@@ -130,3 +130,11 @@ const html = '<!DOCTYPE html>
   </script>
 </html>'
 ```
+
+- Regular markdown list point 1
+- List point 2
+- List point 3
+
+1. Numbered markdown list point 1
+2. List point 2
+3. List point 3
diff --git a/cmd/tools/vdoc/tests/testdata/output_formats/main.ansi b/cmd/tools/vdoc/tests/testdata/output_formats/main.ansi
@@ -110,6 +110,14 @@ const html = '<!DOCTYPE html>
     }
   </script>
 </html>'
+
+Regular markdown list point 1
+List point 2
+List point 3
+
+Numbered markdown list point 1
+List point 2
+List point 3
 [94mmodule[39m [32mmain[39m
     ## Description
 
@@ -243,6 +251,11 @@ const html = '<!DOCTYPE html>
     </html>'
     ```
 
+    - Regular markdown list point 1
+    - List point 2
+    - List point 3
+
+    1. Numbered markdown list point 1 2. List point 2 3. List point 3
 
 [94mconst[39m omega = [94m3[39m [90m// should be first[39m
 [94mconst[39m alpha = [94m5[39m [90m// should be in the middle[39m

diff --git a/cmd/tools/vdoc/tests/testdata/output_formats/main.html b/cmd/tools/vdoc/tests/testdata/output_formats/main.html
@@ -90,7 +90,7 @@ <h2>Description</h2><p>This is an example of a an .md file, used for adding more
       console.log(res);
     }
   &lt;/script&gt;
-&lt;/html&gt;'</span></code></pre>
+&lt;/html&gt;'</span></code></pre><ul><li>Regular markdown list point 1</li><li>List point 2</li><li>List point 3</li></ul><ol><li>Numbered markdown list point 1</li><li>List point 2</li><li>List point 3</li></ol>
 
 </section>
 

diff --git a/cmd/tools/vdoc/tests/testdata/output_formats/main.text b/cmd/tools/vdoc/tests/testdata/output_formats/main.text
@@ -131,6 +131,11 @@ module main
     </html>'
     ```
 
+    - Regular markdown list point 1
+    - List point 2
+    - List point 3
+
+    1. Numbered markdown list point 1 2. List point 2 3. List point 3
 
 const omega = 3 // should be first
 const alpha = 5 // should be in the middle