github.com/SDLMoe/hugo@v0.47.1/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  import (
    19  	"encoding/json"
    20  )
    21  
    22  // DocProviders contains all DocProviders added to the system.
    23  var DocProviders = make(map[string]DocProvider)
    24  
    25  // AddDocProvider adds or updates the DocProvider for a given name.
    26  func AddDocProvider(name string, provider DocProvider) {
    27  	DocProviders[name] = provider
    28  }
    29  
    30  // DocProvider is used to save arbitrary JSON data
    31  // used for the generation of the documentation.
    32  type DocProvider func() map[string]interface{}
    33  
    34  // MarshalJSON returns a JSON representation of the DocProvider.
    35  func (d DocProvider) MarshalJSON() ([]byte, error) {
    36  	return json.MarshalIndent(d(), "", "  ")
    37  }