api

package
v0.0.0-...-402a1d8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 9, 2020 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type HTML 

type HTML struct {
	Meta  map[string]interface{}
	CSS   bytes.Buffer
	Value bytes.Buffer
}

HTML is a transformed Markdown document

type MarkdownParser 

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

A MarkdownParser transforms markdown documents into HTML.MarkdownParser Supports YAML front-matter and syntax highlighting.

func NewMarkdownParser 

func NewMarkdownParser() *MarkdownParser

NewMarkdownParser creates and initializes a new MarkdownParser

func (*MarkdownParser) Transform 

func (p *MarkdownParser) Transform(markdown []byte) (*HTML, error)

Transform returns a HTML document with CSS (if document has code blocks) and metadata (if document has YAML front-matter)

type Page 

type Page struct {
	FullPath                 string
	FileName                 string
	FileNameWithoutExtension string
	NumberOfSubdirectories   int
	SubDirectories           string
}

func NewPage 

func NewPage(path string) *Page

type PageIterator 

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

func NewPageIterator 

func NewPageIterator(pages []string) *PageIterator

func (*PageIterator) HasNext 

func (p *PageIterator) HasNext() bool

func (*PageIterator) Next 

func (p *PageIterator) Next() *Page

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.