goldsmith-components: github.com/FooSoft/goldsmith-components/plugins/summary Index | Files

package summary

import "github.com/FooSoft/goldsmith-components/plugins/summary"

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

Package Files

summary.go

type Summary Uses

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

Summary chainable context.

func New Uses

func New() *Summary

New creates a new instance of the Summary plugin.

func (*Summary) Initialize Uses

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

func (*Summary) Name Uses

func (*Summary) Name() string

func (*Summary) Process Uses

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

func (*Summary) SummaryKey Uses

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

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

func (*Summary) SummaryPath Uses

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

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

func (*Summary) TitleKey Uses

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

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

func (*Summary) TitlePath Uses

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

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

Package summary imports 4 packages (graph) and is imported by 1 packages. Updated 2019-04-08. Refresh now. Tools for package owners.