README
¶
goldmarkmodifier
goldmarkmodifier is a subproject of kbs (WIP), which is responsible for providing the "Markdown AST editing capabilities" needed to implement the "markdown project" in kbs.
The goldmarkmodifier is a tool that allows you to modify the ast of markdown, extending the functionality of goldmark to allow you to edit the ast of markdown generated by goldmark.
With goldmarkmodifier you can easily edit the markdown asts parsed by goldmark as follows:
- Insert arbitrary text
- Parse and insert another Markdown file
In addition, goldmarkmodifier also provides some quick ways to manipulate ast by providing a data structure called Mapping, which allows you to set up matching rules and add, delete, replace, etc. to the matched structure in ast.
Getting started
Execute go run ./example to see the example
Documentation
¶
Index ¶
- type Mapper
- type Matcher
- type Modifier
- func (mod *Modifier) CreateSubNodeAndModifier(source []byte) (*Modifier, error)
- func (mod *Modifier) CreateSubNodeModifier(node ast.Node) (*Modifier, error)
- func (mod *Modifier) Dump()
- func (mod *Modifier) Markdown() goldmark.Markdown
- func (mod *Modifier) Node() ast.Node
- func (mod *Modifier) Render(w io.Writer) error
- func (mod *Modifier) ReplaceNode(rs ...Mapper) error
- func (mod *Modifier) Root() *Modifier
- func (mod *Modifier) Source() []byte
- func (mod *Modifier) WarpText(source string) ast.Node
- func (mod *Modifier) WrapNode(source []byte) (ast.Node, error)
- type Replacer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Modifier ¶
type Modifier struct {
// contains filtered or unexported fields
}
Source Files
Directories