aboutsummaryrefslogtreecommitdiffhomepage
path: root/docshelper/docs.go
blob: 17e0ccd91ba2900da3518e9dc4a9aa74b62678ec (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
// Copyright 2017-present The Hugo Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

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

import (
	"encoding/json"
)

// DocProviders contains all DocProviders added to the system.
var DocProviders = make(map[string]DocProvider)

// AddDocProvider adds or updates the DocProvider for a given name.
func AddDocProvider(name string, provider DocProvider) {
	if prev, ok := DocProviders[name]; !ok {
		DocProviders[name] = provider
	} else {
		DocProviders[name] = merge(prev, provider)
	}
}

// DocProvider is used to save arbitrary JSON data
// used for the generation of the documentation.
type DocProvider func() map[string]interface{}

// MarshalJSON returns a JSON representation of the DocProvider.
func (d DocProvider) MarshalJSON() ([]byte, error) {
	return json.MarshalIndent(d(), "", "  ")
}

func merge(a, b DocProvider) DocProvider {
	next := a()
	for k, v := range b() {
		next[k] = v
	}
	return func() map[string]interface{} {
		return next
	}
}