summary

Documentation

Overview

Package summary generates a summary and title for HTML files using CSS selectors. This plugin is useful when combined with other plugins such as "collection" to create blog post previews.

Index

• type Summary
  • func New() *Summary
  • func (*Summary) Initialize(context *goldsmith.Context) error
  • func (*Summary) Name() string
  • func (self *Summary) Process(context *goldsmith.Context, inputFile *goldsmith.File) error
  • func (self *Summary) SummaryKey(key string) *Summary
  • func (self *Summary) SummaryPath(path string) *Summary
  • func (self *Summary) TitleKey(key string) *Summary
  • func (self *Summary) TitlePath(path string) *Summary

Types

type Summary

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

Summary chainable context.

func New

func New() *Summary

New creates a new instance of the Summary plugin.

func (*Summary) Initialize

func (*Summary) Initialize(context *goldsmith.Context) error

func (*Summary) Name

func (*Summary) Name() string

func (*Summary) Process

func (self *Summary) Process(context *goldsmith.Context, inputFile *goldsmith.File) error

func (*Summary) SummaryKey

func (self *Summary) SummaryKey(key string) *Summary

SummaryKey sets the metadata key used to store the file summary (default: "Summary").

func (*Summary) SummaryPath

func (self *Summary) SummaryPath(path string) *Summary

SummaryPath sets the CSS path used to retrieve the file summary (default: "p").

func (*Summary) TitleKey

func (self *Summary) TitleKey(key string) *Summary

TitleKey sets the metadata key used to store the file title (default: "Title").

func (*Summary) TitlePath

func (self *Summary) TitlePath(path string) *Summary

TitlePath sets CSS path used to retrieve the file title (default: "h1").