source

Documentation

Overview

Handle markdown source and helper methods

Index

• type Links
• type Rendered
• type Source
  • func (s *Source) ExtractLinks() (*Links, error)
  • func (s *Source) ExtractMetadata() (*metadata.Metadata, error)
  • func (s *Source) ToHTML() (*Rendered, error)

Types

type Links

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

type Rendered

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

type Source

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

func (*Source) ExtractLinks

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

Parse b to find all other links within the document.

func (*Source) ExtractMetadata

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

Parse metadata (frontmatter) from source b.

func (*Source) ToHTML

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

Read in b and parse body. Frontmatter is reprocessed to strip it.