package
0.0.0-20231109225250-22a6844f1611
Repository: https://github.com/pulberg/terraform-docs.git
Documentation: pkg.go.dev

# Functions

ConvertMultiLineText converts a multi-line text into a suitable Markdown representation.
ConvertOneLineCodeBlock converts a multi-line code block into a one-liner.
CreateAnchorAsciidoc creates HTML anchor for AsciiDoc format.
CreateAnchorMarkdown creates HTML anchor for Markdown format.
EscapeCharacters escapes characters which have special meaning in Markdown into their corresponding literal.
GenerateIndentation generates indentation of Markdown and AsciiDoc headers with base level of provided 'settings.IndentLevel' plus any extra level needed for subsection (e.g.
New returns new instance of Template.
NormalizeURLs runs after escape function and normalizes URL back to the original state.
SanitizeAsciidocTable converts passed 'string' to suitable AsciiDoc representation for a table.
SanitizeDocument converts passed 'string' to suitable Markdown or AsciiDoc representation for a document.
SanitizeMarkdownTable converts passed 'string' to suitable Markdown representation for a table.
SanitizeName escapes underscore character which have special meaning in Markdown.
SanitizeSection converts passed 'string' to suitable Markdown or AsciiDoc representation for a document.

# Structs

Item represents a named templated which can reference other named templated too.
Template represents a new Template with given name and content to be rendered with provided settings with use of built-in and custom functions.