github.com/kovansky/hugo@v0.92.3-0.20220224232819-63076e4ff19f/docshelper/docs.go (about)

     1  // Copyright 2017-present The Hugo Authors. All rights reserved.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  // http://www.apache.org/licenses/LICENSE-2.0
     7  //
     8  // Unless required by applicable law or agreed to in writing, software
     9  // distributed under the License is distributed on an "AS IS" BASIS,
    10  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    11  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  // Package docshelper provides some helpers for the Hugo documentation, and
    15  // is of limited interest for the general Hugo user.
    16  package docshelper
    17  
    18  type (
    19  	DocProviderFunc = func() DocProvider
    20  	DocProvider     map[string]map[string]interface{}
    21  )
    22  
    23  var docProviderFuncs []DocProviderFunc
    24  
    25  func AddDocProviderFunc(fn DocProviderFunc) {
    26  	docProviderFuncs = append(docProviderFuncs, fn)
    27  }
    28  
    29  func GetDocProvider() DocProvider {
    30  	provider := make(DocProvider)
    31  
    32  	for _, fn := range docProviderFuncs {
    33  		p := fn()
    34  		for k, v := range p {
    35  			if prev, found := provider[k]; !found {
    36  				provider[k] = v
    37  			} else {
    38  				merge(prev, v)
    39  			}
    40  		}
    41  	}
    42  
    43  	return provider
    44  }
    45  
    46  // Shallow merge
    47  func merge(dst, src map[string]interface{}) {
    48  	for k, v := range src {
    49  		dst[k] = v
    50  	}
    51  }