Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

downmark

package module

Go to main page

Versions in this module

v0

v0.4.1

Jul 22, 2026

v0.4.0

Jul 17, 2026

Changes in this version

type Engine

+ func (e *Engine) CanConvert(hints StreamInfo) bool

v0.3.0

Jul 16, 2026

v0.2.0

Jul 15, 2026

Changes in this version

+ var ErrInputTooLarge = errors.New("downmark: input exceeds size limit")

+ var ErrResultTooLarge = errors.New("downmark: result exceeds size limit")

+ func ResultLimit(ctx context.Context) (int, bool)

+ func WithResultLimit(ctx context.Context, maxBytes int) context.Context

+ type InputLimitConverter interface

+ InputLimit func() int64

type Priority

+ const PriorityArchive

v0.1.1

Jul 13, 2026

v0.1.0

Jul 13, 2026

Changes in this version

+ var ErrUnsupportedFormat = errors.New("downmark: unsupported format")

+ type AttemptError struct

+ Converter string

+ Err error

+ func (e *AttemptError) Error() string

+ func (e *AttemptError) Unwrap() error

+ type ConversionError struct

+ Attempts []*AttemptError

+ func (e *ConversionError) Error() string

+ func (e *ConversionError) Unwrap() []error

+ type Converter interface

+ Accepts func(info StreamInfo) bool

+ Convert func(ctx context.Context, input io.ReadSeeker, info StreamInfo) (*Result, error)

+ type Engine struct

+ func New(opts ...Option) *Engine

+ func (e *Engine) Convert(ctx context.Context, r io.Reader, hints StreamInfo) (*Result, error)

+ func (e *Engine) ConvertFile(ctx context.Context, path string) (*Result, error)

+ func (e *Engine) Register(c Converter, p Priority)

+ type Option func(*Engine)

+ func WithHTTPClient(c *http.Client) Option

+ func WithoutBuiltins() Option

+ type Priority int

+ const PriorityGeneric

+ const PrioritySpecific

+ type Result struct

+ Markdown string

+ Title string

+ type StreamInfo struct

+ Charset string

+ Extension string

+ Filename string

+ LocalPath string

+ MIMEType string

+ URL string

+ func (s StreamInfo) Matches(exts []string, mimePrefixes []string) bool