configdoc

func Generate ¶

func Generate(toml, header, example string, extendedDescriptions map[string]string) (string, error)

Generate returns MarkDown documentation generated from the TOML string. - Each field but include a trailing comment of either FieldDefault or FieldExample. - If a description begins with TokenAdvanced, then a warning will be included. - The markdown wil begin with the header, followed by the example - Extended descriptions can be applied to top level tables