check

Documentation

Overview

Package check implements markdown basic checkings.

Index

• func WithAutofix(on bool) option
• func WithMarkdownDir(dir string) option
• func WithMetaDir(dir string) option
• type CheckResult
  • func Check(opts ...option) (res []*CheckResult, err error)

Functions

func WithAutofix

func WithAutofix(on bool) option

WithAutofix set auto fix during checking.

func WithMarkdownDir

func WithMarkdownDir(dir string) option

WithMarkdownDir set markdown path to checking.

func WithMetaDir

func WithMetaDir(dir string) option

WithMetaDir set markdown meta data path for checking.

Types

type CheckResult

type CheckResult struct {
	Path string `json:"path"`
	Text string `json:"text,omitempty"`
	Err  string `json:"err,omitempty"`
	Warn string `json:"warn,omitempty"`
}

func Check

func Check(opts ...option) (res []*CheckResult, err error)