Merge pull request #13 from wuespace/better-md

Add multi-paragraph description support to Markdown `docs` writer

Author: pklaschka

.env.example

@@ -24,4 +24,10 @@ REQUIRED_VARIABLE=
 # REQUIRED_VARIABLE=EXAMPLE_VALUE_1
 # REQUIRED_VARIABLE=EXAMPLE_VALUE_2
 #
+# Multi-paragraph description of REQUIRED_VARIABLE_FILE
+# REQUIRED_VARIABLE_FILE is a required variable that is used to store the path to a file
+# that contains the value of the required variable. The file is mounted as a secret
+# in the container. The value of the required variable is read from the file at runtime.
+#
+# The file should be mounted at the path specified by the REQUIRED_VARIABLE_FILE variable.
 # REQUIRED_VARIABLE_FILE=/run/secrets/required_variable

lib/parse.ts

@@ -58,9 +58,9 @@ export function parse(
     }
 
     // Descriptions
-    if (currentLine.startsWith("# ")) {
+    if (currentLine.startsWith("#")) {
       // A comment that isn't a variable definition is a description
-      ast.registerDescription(currentLine.slice(2));
+      ast.registerDescription(currentLine.slice(1).trim());
       continue;
     }
   }