From b9b7c0bf3b3f2ee89b05bc24d41748d513d7c087 Mon Sep 17 00:00:00 2001 From: kalipso Date: Tue, 31 Oct 2023 00:44:49 +0100 Subject: [PATCH] [docs] change docbuilder markdown output --- cmd/docbuilder/docbuilder.go | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/cmd/docbuilder/docbuilder.go b/cmd/docbuilder/docbuilder.go index ad4e1bc..d7c1215 100644 --- a/cmd/docbuilder/docbuilder.go +++ b/cmd/docbuilder/docbuilder.go @@ -13,11 +13,19 @@ import ( func getMarkdown(documenter internal.Documenter) string { var result string - result += fmt.Sprintf("# %v\n%v\n## Options:\n", documenter.GetName(), documenter.GetDescription()) + result += fmt.Sprintf("# %v\n%v\n\n", documenter.GetName(), documenter.GetDescription()) + + result += fmt.Sprintf("*Example:*\n``` json\n%v\n```\n## Options:\n", documenter.GetExample()) for _, opt := range documenter.GetOptions() { + sanitizedDefault := "\"\"" + + if len(opt.Default) > 0 { + sanitizedDefault = opt.Default + } + result += fmt.Sprintf("### %v\n%v \n\n*Type:* %v \n\n*Default:* ```%v``` \n", - opt.Name, opt.Description, opt.Type, opt.Default) + opt.Name, opt.Description, opt.Type, sanitizedDefault) } return result