gan

package

v0.0.0-...-d72ceb1 Latest Latest Go to latest Published: Mar 19, 2023 License: MIT Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var DefaultDB = mustNew()

View Source

var DefaultMarkdown = goldmark.New(
	goldmark.WithExtensions(
		&wikilink.Extender{
			Resolver: DefaultDB,
		},
	),
)

func Build(src, dst string) error

func Render() error

type Backlink struct {
	Note
	Context []string
}

type DB struct {
	*sql.DB
	// contains filtered or unexported fields
}

func New() (*DB, error)

func (db DB) FindByTitle(title string) (*Note, error)

func (db DB) ResolveWikilink(node *wikilink.Node) (destination []byte, err error)

type MarkdownFile struct {
	Path    string
	Content []byte
}

func GetAll(dir string) ([]MarkdownFile, error)

type Note struct {
	ID      int64
	Path    string
	Content string

	HTML  template.HTML
	Title string
}

func GetAllNotes() ([]Note, error)

func (note *Note) Backlinks() ([]Backlink, error)

func (p *Note) Parse() error

func (p *Note) Put() error

func (p Note) Render() error

func (p Note) SelfPath() string

func (note *Note) UpdateReferences() error

type Reference struct {
	SourceID      int64
	DestinationID int64
	Rel           string
	Context       string
}

func (p *Reference) Put() error

type ShowNote struct {
	*Note
	Backlinks []Backlink
}