mdencoder

README

Markdown Encoder

mdecoder is a library encoding/decoding markdown to go struct

---

Documentation

Index

• func Marshal(obj any) ([]byte, error)
• type Encoder
  • func NewEncoder(w io.Writer) *Encoder
  • func (e *Encoder) Encode(obj any) error
• type Marshaler
• type StructMarkdownStyle

Functions

func Marshal

func Marshal(obj any) ([]byte, error)

Marshal converts a struct instance to Markdown based on `jsonschema` tags.

Types

type Encoder

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

func NewEncoder

func NewEncoder(w io.Writer) *Encoder

func (*Encoder) Encode

func (e *Encoder) Encode(obj any) error

type Marshaler

type Marshaler interface {
	MarshalMarkdown() ([]byte, error)
}

type StructMarkdownStyle

type StructMarkdownStyle int

const (
	StructMdTitleStyle StructMarkdownStyle = iota
	StructMdListStyle
	StructMdInListStyle
)