Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  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
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

mdformatter

package

Go to main page

Versions in this module

v0

v0.9.0

Sep 6, 2021

Changes in this version

+ type BackMatterTransformer interface

+ Close func(ctx SourceContext) error

+ TransformBackMatter func(ctx SourceContext) ([]byte, error)

+ type FormatFrontMatterTransformer struct

+ func (FormatFrontMatterTransformer) Close(SourceContext) error

+ func (FormatFrontMatterTransformer) TransformFrontMatter(_ SourceContext, frontMatter map[string]interface{}) ([]byte, error)

type Option

+ func WithBackMatterTransformer(bm BackMatterTransformer) Option

+ func WithMetrics(reg *prometheus.Registry) Option

+ func WithSoftWraps() Option

type SourceContext

+ LineNumbers string

v0.2.1

Feb 1, 2021

v0.2.0

Dec 28, 2020

Changes in this version

type CodeBlockTransformer

+ Close func(ctx SourceContext) error

+ type FormatFrontMatter struct

+ func (FormatFrontMatter) Close(SourceContext) error

+ func (FormatFrontMatter) TransformFrontMatter(_ SourceContext, frontMatter map[string]interface{}) ([]byte, error)

type FrontMatterTransformer

+ Close func(ctx SourceContext) error

type LinkTransformer

+ Close func(ctx SourceContext) error

+ type SourceContext struct

+ Filepath string

v0.1.0

Dec 23, 2020

Changes in this version

+ func Format(ctx context.Context, logger log.Logger, files []string, opts ...Option) error

+ type CodeBlockTransformer interface

+ TransformCodeBlock func(ctx context.Context, docPath string, infoString []byte, code []byte) ([]byte, error)

+ type Diffs []gitdiff.Diff

+ func IsFormatted(ctx context.Context, logger log.Logger, files []string, opts ...Option) (diffs Diffs, err error)

+ func (d Diffs) String() string

+ type Formatter struct

+ func New(ctx context.Context, opts ...Option) *Formatter

+ func (f *Formatter) Format(file *os.File, out io.Writer) error

+ type FrontMatterTransformer interface

+ TransformFrontMatter func(ctx context.Context, docPath string, frontMatter map[string]interface{}) ([]byte, error)

+ type LinkTransformer interface

+ TransformDestination func(ctx context.Context, docPath string, destination []byte) ([]byte, error)

+ type Option func(*Formatter)

+ func WithCodeBlockTransformer(cb CodeBlockTransformer) Option

+ func WithFrontMatterTransformer(fm FrontMatterTransformer) Option

+ func WithLinkTransformer(l LinkTransformer) Option

+ type RemoveFrontMatter struct

+ func (RemoveFrontMatter) Close() error

+ func (RemoveFrontMatter) TransformFrontMatter(_ context.Context, _ string, frontMatter map[string]interface{}) ([]byte, error)