Fix gendoc template

iotaledger · Sep 20, 2022 · 6132c65 · 6132c65
1 parent d4547a3
commit 6132c65
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 13 deletions.
diff --git a/documentation/docs/configuration.md b/documentation/docs/configuration.md
@@ -1,9 +1,6 @@
-<!---
-!!! DO NOT MODIFY !!!
-
-This file is auto-generated by the gendoc tool based on the source code of the app.
--->
 ---
+# !!! DO NOT MODIFY !!!
+# This file is auto-generated by the gendoc tool based on the source code of the app.
 description: This section describes the configuration parameters and their types for INX-POI.
 keywords:
 - IOTA Node 

diff --git a/tools/gendoc/main.go b/tools/gendoc/main.go
@@ -3,6 +3,7 @@ package main
 import (
 	"fmt"
 	"os"
+	"strings"
 
 	"github.com/iotaledger/hive.go/apputils/config"
 	"github.com/iotaledger/hive.go/core/app"
@@ -11,12 +12,7 @@ import (
 
 func createMarkdownFile(app *app.App, markdownHeaderPath string, markdownFilePath string, ignoreFlags map[string]struct{}, replaceTopicNames map[string]string) {
 
-	markdownHeader := []byte(`<!---
-!!! DO NOT MODIFY !!!
-
-This file is auto-generated by the gendoc tool based on the source code of the app.
--->
-`)
+	markdownHeader := ""
 
 	if markdownHeaderPath != "" {
 		var err error
@@ -25,12 +21,26 @@ This file is auto-generated by the gendoc tool based on the source code of the a
 			panic(err)
 		}
 
-		markdownHeader = append(markdownHeader, markdownHeaderFile...)
+		markdownHeader = string(markdownHeaderFile)
+	}
+
+	if strings.HasPrefix(markdownHeader, "---") {
+		// header contains frontmatter code block
+		markdownHeader = strings.Replace(markdownHeader, "---", `---
+# !!! DO NOT MODIFY !!!
+# This file is auto-generated by the gendoc tool based on the source code of the app.`, 1)
+	} else {
+		markdownHeader = `<!---
+!!! DO NOT MODIFY !!!
+
+This file is auto-generated by the gendoc tool based on the source code of the app.
+-->
+` + markdownHeader
 	}
 
 	println(fmt.Sprintf("Create markdown file for %s...", app.Info().Name))
 	md := config.GetConfigurationMarkdown(app.Config(), app.FlagSet(), ignoreFlags, replaceTopicNames)
-	if err := os.WriteFile(markdownFilePath, append(markdownHeader, []byte(md)...), os.ModePerm); err != nil {
+	if err := os.WriteFile(markdownFilePath, append([]byte(markdownHeader), []byte(md)...), os.ModePerm); err != nil {
 		panic(err)
 	}
 	println(fmt.Sprintf("Markdown file for %s stored: %s", app.Info().Name, markdownFilePath))