markdown

package
v0.26.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 11, 2026 License: MPL-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package markdown provides Markdown parsing helpers (built on goldmark) used by the documentation checks.

Deprecated: tfproviderdocs is no longer maintained. All functionality has been superseded by github.com/YakDriver/swissshepherd. Please migrate: https://github.com/YakDriver/swissshepherd

Index

Constants

View Source
const (
	FencedCodeBlockLanguageConsole   = "console"
	FencedCodeBlockLanguageHcl       = "hcl"
	FencedCodeBlockLanguageMissing   = "MISSING"
	FencedCodeBlockLanguageTerraform = "terraform"
)

Variables

This section is empty.

Functions

func FencedCodeBlockLanguage

func FencedCodeBlockLanguage(fcb *ast.FencedCodeBlock, source []byte) string

FencedCodeBlockLanguage returns the language or "MISSING"

func FencedCodeBlockText

func FencedCodeBlockText(fcb *ast.FencedCodeBlock, source []byte) string

FencedCodeBlockText returns the text

func Parse

func Parse(source []byte) (ast.Node, map[string]any)

Parse converts a Markdown source into AST and metadata

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL