index

package

v0.0.0-...-883b603 Latest Latest Go to latest Published: May 16, 2022 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

Documentation ¶

Overview ¶

Package index creates metadata for directory listings and generates index pages for every directory which contains other files. This is useful for creating static directory views for downloads, image galleries, etc.

Index ¶

type Entry
type Index
- func New(indexProps map[string]interface{}) *Index

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Entry ¶

type Entry struct {
	Name  string
	Path  string
	IsDir bool
	File  *goldsmith.File
}

Entry contains information about a directory item.

type Index ¶

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

Index chainable plugin context.

func New ¶

func New(indexProps map[string]interface{}) *Index

New creates a new instance of the Index plugin. The meta parameter allows additional metadata to be provided for generated indices.

func (*Index) FilesKey ¶

func (self *Index) FilesKey(key string) *Index

FilesKey sets the metadata key used to access the files in the current directory (default: "Files").

func (*Index) Finalize ¶

func (self *Index) Finalize(context *goldsmith.Context) error

func (*Index) IndexFilename ¶

func (self *Index) IndexFilename(filename string) *Index

IndexFilename sets the name of the file to be created as the directory index (default: "index.html").

func (*Index) Name ¶

func (*Index) Name() string

func (*Index) Process ¶

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

Source Files ¶

View all Source files

index.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL