renderer

package
v0.2.5 Latest Latest
Warning

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

Go to latest
Published: Jun 17, 2025 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

Package renderer provides markdown rendering functionality.

Index

Constants

View Source
const (
	// SecondHeadingLevel represents heading level 2
	SecondHeadingLevel = 2
)

Constants

Variables

This section is empty.

Functions

This section is empty.

Types

type MarkdownRenderer

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

MarkdownRenderer renders AST back to markdown format

func New

func New() *MarkdownRenderer

New creates a new markdown renderer

func (*MarkdownRenderer) Render

func (r *MarkdownRenderer) Render(doc *parser.Document, cfg *config.Config) (string, error)

Render renders the AST to markdown string with whitespace normalization.

func (*MarkdownRenderer) RenderTo

func (r *MarkdownRenderer) RenderTo(w io.Writer, doc *parser.Document, cfg *config.Config) error

RenderTo renders the AST to a writer

type Renderer

type Renderer interface {
	// Render renders the AST to markdown
	Render(doc *parser.Document, cfg *config.Config) (string, error)
	// RenderTo renders the AST to a writer
	RenderTo(w io.Writer, doc *parser.Document, cfg *config.Config) error
}

Renderer represents a renderer that converts AST back to markdown

Jump to

Keyboard shortcuts

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