terraform-docs · mcdonnnj · Jan 2, 2024 · Jan 2, 2024 · Jan 2, 2024 · Jan 2, 2024
diff --git a/cmd/markdown/markdown.go b/cmd/markdown/markdown.go
@@ -33,6 +33,7 @@ func NewCommand(runtime *cli.Runtime, config *print.Config) *cobra.Command {
 
 	// flags
 	cmd.PersistentFlags().BoolVar(&config.Settings.Anchor, "anchor", true, "create anchor links")
+	cmd.PersistentFlags().BoolVar(&config.Settings.AtxClosed, "atx-closed", false, "close ATX style headers")
 	cmd.PersistentFlags().BoolVar(&config.Settings.Default, "default", true, "show Default column or section")
 	cmd.PersistentFlags().BoolVar(&config.Settings.Escape, "escape", true, "escape special characters")
 	cmd.PersistentFlags().BoolVar(&config.Settings.HTML, "html", true, "use HTML tags in genereted output")

diff --git a/docs/reference/markdown-document.md b/docs/reference/markdown-document.md
@@ -26,6 +26,7 @@ terraform-docs markdown document [PATH] [flags]
 
 ```console
       --anchor                      create anchor links (default true)
+      --atx-closed                  close ATX style headers
   -c, --config string               config file name (default ".terraform-docs.yml")
       --default                     show Default column or section (default true)
       --escape                      escape special characters (default true)

diff --git a/docs/reference/markdown-table.md b/docs/reference/markdown-table.md
@@ -26,6 +26,7 @@ terraform-docs markdown table [PATH] [flags]
 
 ```console
       --anchor                      create anchor links (default true)
+      --atx-closed                  close ATX style headers
   -c, --config string               config file name (default ".terraform-docs.yml")
       --default                     show Default column or section (default true)
       --escape                      escape special characters (default true)

diff --git a/docs/reference/markdown.md b/docs/reference/markdown.md
@@ -20,6 +20,7 @@ terraform-docs markdown [PATH] [flags]
 
 ```console
       --anchor       create anchor links (default true)
+      --atx-closed   close ATX style headers
       --default      show Default column or section (default true)
       --escape       escape special characters (default true)
   -h, --help         help for markdown

diff --git a/format/markdown_document_test.go b/format/markdown_document_test.go
@@ -138,6 +138,23 @@ func TestMarkdownDocument(t *testing.T) {
 				}),
 			),
 		},
+		"WithAtxClosed": {
+			config: testutil.WithSections(
+				testutil.WithHTML(),
+				testutil.With(func(c *print.Config) {
+					c.Settings.AtxClosed = true
+				}),
+			),
+		},
+		"EmptyWithAtxClosed": {
+			config: testutil.WithDefaultSections(
+				testutil.WithHTML(),
+				testutil.With(func(c *print.Config) {
+					c.ModuleRoot = "empty"
+					c.Settings.AtxClosed = true
+				}),
+			),
+		},
 
 		// Only section
 		"OnlyDataSources": {

diff --git a/format/markdown_table_test.go b/format/markdown_table_test.go
@@ -138,6 +138,23 @@ func TestMarkdownTable(t *testing.T) {
 				}),
 			),
 		},
+		"WithAtxClosed": {
+			config: testutil.WithSections(
+				testutil.WithHTML(),
+				testutil.With(func(c *print.Config) {
+					c.Settings.AtxClosed = true
+				}),
+			),
+		},
+		"EmptyWithAtxClosed": {
+			config: testutil.WithDefaultSections(
+				testutil.WithHTML(),
+				testutil.With(func(c *print.Config) {
+					c.ModuleRoot = "empty"
+					c.Settings.AtxClosed = true
+				}),
+			),
+		},
 
 		// Only section
 		"OnlyDataSources": {

diff --git a/format/templates/markdown_document_inputs.tmpl b/format/templates/markdown_document_inputs.tmpl
@@ -2,17 +2,17 @@
     {{- if .Config.Settings.Required -}}
         {{- if not .Module.RequiredInputs -}}
             {{- if not .Config.Settings.HideEmpty -}}
-                {{- indent 0 "#" }} Required Inputs
+                {{- indent 0 "#" }} Required Inputs{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
                 No required inputs.
             {{ end }}
         {{ else }}
-            {{- indent 0 "#" }} Required Inputs
+            {{- indent 0 "#" }} Required Inputs{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
             The following input variables are required:
             {{- range .Module.RequiredInputs }}
                 {{ printf "\n" }}
-                {{ indent 1 "#" }} {{ anchorNameMarkdown "input" .Name }}
+                {{ indent 1 "#" }} {{ anchorNameMarkdown "input" .Name }}{{ if $.Config.Settings.AtxClosed }} {{ indent 1 "#" }}{{ end }}
 
                 Description: {{ tostring .Description | sanitizeDoc }}
 
@@ -29,17 +29,17 @@
         {{- end }}
         {{- if not .Module.OptionalInputs -}}
             {{- if not .Config.Settings.HideEmpty -}}
-                {{- indent 0 "#" }} Optional Inputs
+                {{- indent 0 "#" }} Optional Inputs{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
                 No optional inputs.
             {{ end }}
         {{ else }}
-            {{- indent 0 "#" }} Optional Inputs
+            {{- indent 0 "#" }} Optional Inputs{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
             The following input variables are optional (have default values):
             {{- range .Module.OptionalInputs }}
                 {{ printf "\n" }}
-                {{ indent 1 "#" }} {{ anchorNameMarkdown "input" .Name }}
+                {{ indent 1 "#" }} {{ anchorNameMarkdown "input" .Name }}{{ if $.Config.Settings.AtxClosed }} {{ indent 1 "#" }}{{ end }}
 
                 Description: {{ tostring .Description | sanitizeDoc }}
 
@@ -57,17 +57,17 @@
     {{ else -}}
         {{- if not .Module.Inputs -}}
             {{- if not .Config.Settings.HideEmpty -}}
-                {{- indent 0 "#" }} Inputs
+                {{- indent 0 "#" }} Inputs{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
                 No inputs.
             {{ end }}
         {{ else }}
-            {{- indent 0 "#" }} Inputs
+            {{- indent 0 "#" }} Inputs{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
             The following input variables are supported:
             {{- range .Module.Inputs }}
                 {{ printf "\n" }}
-                {{ indent 1 "#" }} {{ anchorNameMarkdown "input" .Name }}
+                {{ indent 1 "#" }} {{ anchorNameMarkdown "input" .Name }}{{ if $.Config.Settings.AtxClosed }} {{ indent 1 "#" }}{{ end }}
 
                 Description: {{ tostring .Description | sanitizeDoc }}
 

diff --git a/format/templates/markdown_document_modules.tmpl b/format/templates/markdown_document_modules.tmpl
@@ -1,17 +1,17 @@
 {{- if .Config.Sections.ModuleCalls -}}
     {{- if not .Module.ModuleCalls -}}
         {{- if not .Config.Settings.HideEmpty -}}
-            {{- indent 0 "#" }} Modules
+            {{- indent 0 "#" }} Modules{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
             No modules.
         {{ end }}
     {{ else }}
-        {{- indent 0 "#" }} Modules
+        {{- indent 0 "#" }} Modules{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
         The following Modules are called:
         {{- range .Module.ModuleCalls }}
 
-            {{ indent 1 "#" }} {{ anchorNameMarkdown "module" .Name }}
+            {{ indent 1 "#" }} {{ anchorNameMarkdown "module" .Name }}{{ if $.Config.Settings.AtxClosed }} {{ indent 1 "#" }}{{ end }}
 
             Source: {{ .Source }}
 

diff --git a/format/templates/markdown_document_outputs.tmpl b/format/templates/markdown_document_outputs.tmpl
@@ -1,17 +1,17 @@
 {{- if .Config.Sections.Outputs -}}
     {{- if not .Module.Outputs -}}
         {{- if not .Config.Settings.HideEmpty -}}
-            {{- indent 0 "#" }} Outputs
+            {{- indent 0 "#" }} Outputs{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
             No outputs.
         {{ end }}
     {{ else }}
-        {{- indent 0 "#" }} Outputs
+        {{- indent 0 "#" }} Outputs{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
         The following outputs are exported:
         {{- range .Module.Outputs }}
 
-            {{ indent 1 "#" }} {{ anchorNameMarkdown "output" .Name }}
+            {{ indent 1 "#" }} {{ anchorNameMarkdown "output" .Name }}{{ if $.Config.Settings.AtxClosed }} {{ indent 1 "#" }}{{ end }}
 
             Description: {{ tostring .Description | sanitizeDoc }}
 

diff --git a/format/templates/markdown_document_providers.tmpl b/format/templates/markdown_document_providers.tmpl
@@ -1,12 +1,12 @@
 {{- if .Config.Sections.Providers -}}
     {{- if not .Module.Providers -}}
         {{- if not .Config.Settings.HideEmpty -}}
-            {{- indent 0 "#" }} Providers
+            {{- indent 0 "#" }} Providers{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
             No providers.
         {{ end }}
     {{ else }}
-        {{- indent 0 "#" }} Providers
+        {{- indent 0 "#" }} Providers{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
         The following providers are used by this module:
         {{- range .Module.Providers }}

diff --git a/format/templates/markdown_document_requirements.tmpl b/format/templates/markdown_document_requirements.tmpl
@@ -1,12 +1,12 @@
 {{- if .Config.Sections.Requirements -}}
     {{- if not .Module.Requirements -}}
         {{- if not .Config.Settings.HideEmpty -}}
-            {{- indent 0 "#" }} Requirements
+            {{- indent 0 "#" }} Requirements{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
             No requirements.
         {{ end }}
     {{ else }}
-        {{- indent 0 "#" }} Requirements
+        {{- indent 0 "#" }} Requirements{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
         The following requirements are needed by this module:
         {{- range .Module.Requirements }}

diff --git a/format/templates/markdown_document_resources.tmpl b/format/templates/markdown_document_resources.tmpl
@@ -1,12 +1,12 @@
 {{- if or .Config.Sections.Resources .Config.Sections.DataSources -}}
     {{- if not .Module.Resources -}}
         {{- if not .Config.Settings.HideEmpty -}}
-            {{- indent 0 "#" }} Resources
+            {{- indent 0 "#" }} Resources{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
             No resources.
         {{ end }}
     {{ else }}
-        {{- indent 0 "#" }} Resources
+        {{- indent 0 "#" }} Resources{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
         The following resources are used by this module:
         {{ range .Module.Resources }}

diff --git a/format/templates/markdown_table_inputs.tmpl b/format/templates/markdown_table_inputs.tmpl
@@ -1,12 +1,12 @@
 {{- if .Config.Sections.Inputs -}}
     {{- if not .Module.Inputs -}}
         {{- if not .Config.Settings.HideEmpty -}}
-            {{- indent 0 "#" }} Inputs
+            {{- indent 0 "#" }} Inputs{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
             No inputs.
         {{- end }}
     {{ else }}
-        {{- indent 0 "#" }} Inputs
+        {{- indent 0 "#" }} Inputs{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
         | Name | Description |
         {{- if .Config.Settings.Type }} Type |{{ end }}

diff --git a/format/templates/markdown_table_modules.tmpl b/format/templates/markdown_table_modules.tmpl
@@ -1,12 +1,12 @@
 {{- if .Config.Sections.ModuleCalls -}}
     {{- if not .Module.ModuleCalls -}}
         {{- if not .Config.Settings.HideEmpty -}}
-            {{- indent 0 "#" }} Modules
+            {{- indent 0 "#" }} Modules{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
             No modules.
         {{ end }}
     {{ else }}
-        {{- indent 0 "#" }} Modules
+        {{- indent 0 "#" }} Modules{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
         | Name | Source | Version |
         |------|--------|---------|

diff --git a/format/templates/markdown_table_outputs.tmpl b/format/templates/markdown_table_outputs.tmpl
@@ -1,12 +1,12 @@
 {{- if .Config.Sections.Outputs -}}
     {{- if not .Module.Outputs -}}
         {{- if not .Config.Settings.HideEmpty -}}
-            {{- indent 0 "#" }} Outputs
+            {{- indent 0 "#" }} Outputs{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
             No outputs.
         {{ end }}
     {{ else }}
-        {{- indent 0 "#" }} Outputs
+        {{- indent 0 "#" }} Outputs{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
         | Name | Description |{{ if .Config.OutputValues.Enabled }} Value |{{ if $.Config.Settings.Sensitive }} Sensitive |{{ end }}{{ end }}
         |------|-------------|{{ if .Config.OutputValues.Enabled }}-------|{{ if $.Config.Settings.Sensitive }}:---------:|{{ end }}{{ end }}

diff --git a/format/templates/markdown_table_providers.tmpl b/format/templates/markdown_table_providers.tmpl
@@ -1,12 +1,12 @@
 {{- if .Config.Sections.Providers -}}
     {{- if not .Module.Providers -}}
         {{- if not .Config.Settings.HideEmpty -}}
-            {{- indent 0 "#" }} Providers
+            {{- indent 0 "#" }} Providers{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
             No providers.
         {{ end }}
     {{ else }}
-        {{- indent 0 "#" }} Providers
+        {{- indent 0 "#" }} Providers{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
         | Name | Version |
         |------|---------|

diff --git a/format/templates/markdown_table_requirements.tmpl b/format/templates/markdown_table_requirements.tmpl
@@ -1,12 +1,12 @@
 {{- if .Config.Sections.Requirements -}}
     {{- if not .Module.Requirements -}}
         {{- if not .Config.Settings.HideEmpty -}}
-            {{- indent 0 "#" }} Requirements
+            {{- indent 0 "#" }} Requirements{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
             No requirements.
         {{ end }}
     {{ else }}
-        {{- indent 0 "#" }} Requirements
+        {{- indent 0 "#" }} Requirements{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
         | Name | Version |
         |------|---------|

diff --git a/format/templates/markdown_table_resources.tmpl b/format/templates/markdown_table_resources.tmpl
@@ -1,12 +1,12 @@
 {{- if or .Config.Sections.Resources .Config.Sections.DataSources -}}
     {{- if not .Module.Resources -}}
         {{- if not .Config.Settings.HideEmpty -}}
-            {{- indent 0 "#" }} Resources
+            {{- indent 0 "#" }} Resources{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
             No resources.
         {{ end }}
     {{ else }}
-        {{- indent 0 "#" }} Resources
+        {{- indent 0 "#" }} Resources{{ if .Config.Settings.AtxClosed }} {{ indent 0 "#" }}{{ end }}
 
         | Name | Type |
         |------|------|

diff --git a/format/testdata/markdown/document-EmptyWithAtxClosed.golden b/format/testdata/markdown/document-EmptyWithAtxClosed.golden
@@ -0,0 +1,23 @@
+## Requirements ##
+
+No requirements.
+
+## Providers ##
+
+No providers.
+
+## Modules ##
+
+No modules.
+
+## Resources ##
+
+No resources.
+
+## Inputs ##
+
+No inputs.
+
+## Outputs ##
+
+No outputs.