Merge pull request #16 from wuespace/clear-default-value-docs

Clarify default values in Markdown `docs`
wuespace · Dec 8, 2024 · 24349d1 · 24349d1
2 parents d4a53ac + 6d7f3b1
commit 24349d1
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/lib/writers/docs.ts b/lib/writers/docs.ts
@@ -22,7 +22,7 @@ export class DocsWriter implements Writer {
   writeVariable(variable: Variable, prev: string): string {
     // Heading
     const optMarker = variable.optional ? " (optional)" : "";
-    prev += `\n### \`${variable.name}\`${optMarker}\n\n`;
+    prev += `\n### \`${variable.name}\`${optMarker}\n`;
 
     // Description
     variable.description?.split("\n").slice(0, -1).forEach((line) => {
@@ -35,6 +35,7 @@ export class DocsWriter implements Writer {
     }
 
     // Default value
+    prev += '#### Default Value\n\n';
     prev += this.markdownCodeBlock(`${variable.name}=${variable.defaultValue}`);
 
     // Example values