parse

Documentation

Overview

Parses markdown to html

Index

• type Metadata
  • func DefaultMetadata() Metadata
• type Source
  • func (s *Source) ParseInternalLinks() ([]string, []string, error)
  • func (s *Source) ParseMetadata() (Metadata, error)
  • func (s *Source) ParseSource() ([]byte, error)

Types

type Metadata

type Metadata struct {
	Title       string   `yaml:"title"`
	Description string   `yaml:"description"`
	Date        string   `yaml:"date"`
	DateUpdated string   `yaml:"dateUpdated"`
	Layout      string   `yaml:"layout"`
	Tags        []string `yaml:"tags"`
	Pinned      bool     `yaml:"pinned"`
	Unlisted    bool     `yaml:"unlisted"`
	Draft       bool     `yaml:"draft"`
	TOC         bool     `yaml:"toc"`
	ShowHeader  bool     `yaml:"showHeader"`
}

Allowed frontmatter in unmarshalled YAML.

Default values

* Pinned: false

* Unlisted: false

* ShowHeader: true

* Layout: "list"

* Draft: false

* TOC: false

func DefaultMetadata

func DefaultMetadata() Metadata

type Source

type Source struct {
	Body             []byte
	RendersTOC       bool
	RendersHighlight bool
}

func (*Source) ParseInternalLinks

func (s *Source) ParseInternalLinks() ([]string, []string, error)

Parse b to find all other links within the document.

func (*Source) ParseMetadata

func (s *Source) ParseMetadata() (Metadata, error)

Parse metadata (frontmatter) from source b.

func (*Source) ParseSource

func (s *Source) ParseSource() ([]byte, error)

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