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 (*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
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Summary ¶
type Summary struct {
// contains filtered or unexported fields
}
Summary chainable context.
func (*Summary) SummaryKey ¶
SummaryKey sets the metadata key used to store the file summary (default: "Summary").
func (*Summary) SummaryPath ¶
SummaryPath sets the CSS path used to retrieve the file summary (default: "p").
Source Files
Click to show internal directories.
Click to hide internal directories.