mdutils

Documentation

Index

• func CodeBlock(language string, code string) string
• func FormatResourceDescription(description string, args ...any) string
• func FormatSchemaDescription(description string, args ...any) string
• func InlineCodeBlock(code string) string
• type DescriptionFormatter
  • func NewDescriptionFormatter() *DescriptionFormatter
  • func (f *DescriptionFormatter) Format(description string) string

Functions

func CodeBlock

func CodeBlock(language string, code string) string

CodeBlock returns a markdown code block.

Note that it expects the code to be a single line if it is used in list entry.

TODO: Add support for multi-line code in list entry.

func FormatResourceDescription

func FormatResourceDescription(description string, args ...any) string

func FormatSchemaDescription

func FormatSchemaDescription(description string, args ...any) string

func InlineCodeBlock

func InlineCodeBlock(code string) string

Types

type DescriptionFormatter

type DescriptionFormatter struct {
	// contains filtered or unexported fields
}

func NewDescriptionFormatter

func NewDescriptionFormatter() *DescriptionFormatter

func (*DescriptionFormatter) Format

func (f *DescriptionFormatter) Format(description string) string