Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Settings ¶ added in v0.8.0
type Settings struct { // EscapeCharacters escapes special characters (such as | _ * in Markdown and > < in JSON) (default: true) // scope: Markdown EscapeCharacters bool // MarkdownIndent control the indentation of Markdown headers [available: 1, 2, 3, 4, 5] (default: 2) // scope: Markdown MarkdownIndent int // ShowColor print "colorized" version of result in the terminal (default: true) // scope: Pretty ShowColor bool // ShowHeader show "Header" module information (default: true) // scope: Global ShowHeader bool // ShowInputs show "Inputs" information (default: true) // scope: Global ShowInputs bool // ShowOutputs show "Outputs" information (default: true) // scope: Global ShowOutputs bool // ShowProviders show "Providers" information (default: true) // scope: Global ShowProviders bool // ShowRequired show "Required" column when generating Markdown (default: true) // scope: Markdown ShowRequired bool // SortByName sorted rendering of inputs and outputs (default: true) // scope: Global SortByName bool // SortByRequired sort items (inputs, providers) by name and prints required ones first (default: false) // scope: Global SortByRequired bool }
Settings represents all settings
func NewSettings ¶ added in v0.8.0
func NewSettings() *Settings
NewSettings returns new instance of Settings
Click to show internal directories.
Click to hide internal directories.