markdown

Documentation

Index

• type Indexer
  • func New() *Indexer
  • func (i *Indexer) HandleEvent(ctx context.Context, ictx *indexer.Context, event indexer.Event) error
  • func (i *Indexer) Handles(uri string) bool
  • func (i *Indexer) Index(ctx context.Context, ictx *indexer.Context) error
  • func (i *Indexer) Name() string
  • func (i *Indexer) PostIndex(ctx context.Context, ictx *indexer.Context) error
  • func (i *Indexer) Schemes() []string
  • func (i *Indexer) Subscriptions() []indexer.Subscription

Types

type Indexer

type Indexer struct {
	// contains filtered or unexported fields
}

Indexer indexes markdown files, extracting structure (headings, code blocks, links, images).

func New

func New() *Indexer

New creates a new markdown indexer.

func (*Indexer) HandleEvent

func (i *Indexer) HandleEvent(ctx context.Context, ictx *indexer.Context, event indexer.Event) error

func (*Indexer) Handles

func (i *Indexer) Handles(uri string) bool

func (*Indexer) Index

func (i *Indexer) Index(ctx context.Context, ictx *indexer.Context) error

func (*Indexer) Name

func (i *Indexer) Name() string

func (*Indexer) PostIndex

func (i *Indexer) PostIndex(ctx context.Context, ictx *indexer.Context) error

PostIndex resolves local file links after all indexers have completed.

func (*Indexer) Schemes

func (i *Indexer) Schemes() []string

func (*Indexer) Subscriptions

func (i *Indexer) Subscriptions() []indexer.Subscription