Method writeConfigBlock

tools/doc-generator/writer.go:127–178

(block *configBlock)

}

func (w *markdownWriter) writeConfigBlock(block *configBlock) {
	// Title
	if block.name != "" {
		w.out.WriteString("### `" + block.name + "`\n")
		w.out.WriteString("\n")
	}

	// Description
	if block.desc != "" {
		desc := block.desc

		// Wrap the config block name with backticks
		if block.name != "" {
			desc = regexp.MustCompile(regexp.QuoteMeta(block.name)).ReplaceAllStringFunc(desc, func(input string) string {
				return "`" + input + "`"
			})
		}

		// List of all prefixes used to reference this config block.
		if len(block.flagsPrefixes) > 1 {
			sortedPrefixes := sort.StringSlice(block.flagsPrefixes)
			sortedPrefixes.Sort()

			desc += " The supported CLI flags `<prefix>` used to reference this config block are:\n\n"

			for _, prefix := range sortedPrefixes {
				if prefix == "" {
					desc += "- _no prefix_\n"
				} else {
					desc += fmt.Sprintf("- `%s`\n", prefix)
				}
			}

			// Unfortunately the markdown compiler used by the website generator has a bug
			// when there's a list followed by a code block (no matter know many newlines
			// in between). To workaround it we add a non-breaking space.
			desc += "\n&nbsp;"
		}

		w.out.WriteString(desc + "\n")
		w.out.WriteString("\n")
	}

	// Config specs
	spec := &specWriter{}
	spec.writeConfigBlock(block, 0)

	w.out.WriteString("```yaml\n")
	w.out.WriteString(spec.string() + "\n")
	w.out.WriteString("```\n")
	w.out.WriteString("\n")
}

func (w *markdownWriter) string() string {
	return strings.TrimSpace(w.out.String())