Merge pull request #522 from veryl-lang/refine_doc

Adjust document style
veryl-lang · Mar 5, 2024 · 10c9a7f · 10c9a7f
2 parents 7b5db65 + ce46a3c
commit 10c9a7f
Showing 1 changed file with 27 additions and 9 deletions.
diff --git a/crates/veryl/src/doc_builder.rs b/crates/veryl/src/doc_builder.rs
@@ -125,20 +125,32 @@ const MODULE_TMPL: &str = r#"
 ### Parameters
 ---
 
+<table class="table_list">
+<tbody>
 {{#each parameters}}
-#### {{this.name}}: <span class="hljs-type">{{this.typ}}</span>
-{{this.description}}
-
+<tr>
+    <th class="table_list_item">{{this.name}}</th>
+    <td class="table_list_item"><span class="hljs-type">{{this.typ}}</span></td>
+    <td class="table_list_item">{{this.description}}</td>
+</tr>
 {{/each}}
+</tbody>
+</table>
 
 ### Ports
 ---
 
+<table class="table_list">
+<tbody>
 {{#each ports}}
-#### {{this.name}}: <span class="hljs-keyword">{{this.direction}}</span> <span class="hljs-type">{{this.typ}}</span>
-{{this.description}}
-
+<tr>
+    <th class="table_list_item">{{this.name}}</th>
+    <td class="table_list_item"><span class="hljs-keyword">{{this.direction}}</span> <span class="hljs-type">{{this.typ}}</span></td>
+    <td class="table_list_item">{{this.description}}</td>
+</tr>
 {{/each}}
+</tbody>
+</table>
 "#;
 
 #[derive(Serialize)]
@@ -172,11 +184,17 @@ const INTERFACE_TMPL: &str = r#"
 ### Parameters
 ---
 
+<table class="table_list">
+<tbody>
 {{#each parameters}}
-#### {{this.name}}: <span class="hljs-type">{{this.typ}}</span>
-{{this.description}}
-
+<tr>
+    <th class="table_list_item">{{this.name}}</th>
+    <td class="table_list_item"><span class="hljs-type">{{this.typ}}</span></td>
+    <td class="table_list_item">{{this.description}}</td>
+</tr>
 {{/each}}
+</tbody>
+</table>
 "#;
 
 #[derive(Serialize)]