mirror of https://github.com/mickael-menu/zk
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
27 lines
775 B
Go
27 lines
775 B
Go
3 years ago
|
package core
|
||
|
|
|
||
|
|
import (
|
||
|
|
"github.com/mickael-menu/zk/internal/util/opt"
|
||
|
|
)
|
||
|
|
|
||
|
|
// NoteParser parses a note's raw content into its components.
|
||
|
|
type NoteParser interface {
|
||
|
|
Parse(content string) (*ParsedNote, error)
|
||
|
|
}
|
||
|
|
|
||
|
|
// ParsedNote holds the data parsed from the note content.
|
||
|
|
type ParsedNote struct {
|
||
|
|
// Title is the heading of the note.
|
||
|
|
Title opt.String
|
||
|
|
// Lead is the opening paragraph or section of the note.
|
||
|
|
Lead opt.String
|
||
|
|
// Body is the content of the note, including the Lead but without the Title.
|
||
|
|
Body opt.String
|
||
|
|
// Tags is the list of tags found in the note content.
|
||
|
|
Tags []string
|
||
|
|
// Links is the list of outbound links found in the note.
|
||
|
|
Links []Link
|
||
|
|
// Additional metadata. For example, extracted from a YAML frontmatter.
|
||
|
|
Metadata map[string]interface{}
|
||
|
|
}
|