Documentation
¶
Overview ¶
Package check implements markdown basic checkings.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
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)
Source Files
Click to show internal directories.
Click to hide internal directories.