package docshelper

import "github.com/gohugoio/hugo/docshelper"

Package docshelper provides some helpers for the Hugo documentation, and is of limited interest for the general Hugo user.

Index ¶

• Variables
• func AddDocProvider(name string, provider DocProvider)
• type DocProvider
• func (d DocProvider) MarshalJSON() ([]byte, error)

Variables ¶

var DocProviders = make(map[string]DocProvider)

DocProviders contains all DocProviders added to the system.

Functions ¶

func AddDocProvider ¶

func AddDocProvider(name string, provider DocProvider)

AddDocProvider adds or updates the DocProvider for a given name.

Types ¶

type DocProvider ¶

type DocProvider func() map[string]interface{}

DocProvider is used to save arbitrary JSON data used for the generation of the documentation.

func (DocProvider) MarshalJSON ¶

func (d DocProvider) MarshalJSON() ([]byte, error)

MarshalJSON returns a JSON representation of the DocProvider.

Source Files ¶

docs.go