source

package

v3.0.1 Latest Latest Go to latest Published: Dec 29, 2025 License: GPL-3.0 Imports: 17 Imported by: 0

Details

Package source handles markdown source and helper methods

This section is empty.

This section is empty.

This section is empty.

type Links struct {
	BackLinks     []string
	InternalLinks []string
}

type Rendered struct {
	HTML      []byte
	ChromaCSS []byte
}

type Source struct {
	CodeTheme     string
	Body          []byte
	TOC           bool
	CodeHighlight bool
}

func (s *Source) ExtractLinks() (*Links, error)

ExtractLinks walks through all files to collect links within the document.

func (s *Source) ExtractMetadata() (*metadata.Metadata, error)

ExtractMetadata parses metadata (frontmatter) from source.

func (s *Source) ToHTML() (*Rendered, error)

ToHTML reads in soure code and parse body. Frontmatter is reprocessed to strip it.