mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-07 20:30:36 -05:00
3c405f5172
This commit also adds a new command, docshelper, with some utility funcs that adds a JSON datafiles to /docs/data that would be a pain to create and maintain by hand. Fixes #3242
86 lines
2.5 KiB
Go
86 lines
2.5 KiB
Go
package output
|
|
|
|
import (
|
|
"strings"
|
|
|
|
"fmt"
|
|
|
|
"github.com/spf13/hugo/docshelper"
|
|
)
|
|
|
|
// This is is just some helpers used to create some JSON used in the Hugo docs.
|
|
func init() {
|
|
docsProvider := func() map[string]interface{} {
|
|
docs := make(map[string]interface{})
|
|
|
|
docs["formats"] = DefaultFormats
|
|
docs["layouts"] = createLayoutExamples()
|
|
return docs
|
|
}
|
|
|
|
docshelper.AddDocProvider("output", docsProvider)
|
|
}
|
|
|
|
func createLayoutExamples() interface{} {
|
|
|
|
type Example struct {
|
|
Example string
|
|
OutputFormat string
|
|
Suffix string
|
|
Layouts []string `json:"Template Lookup Order"`
|
|
}
|
|
|
|
var (
|
|
basicExamples []Example
|
|
demoLayout = "demolayout"
|
|
demoType = "demotype"
|
|
)
|
|
|
|
for _, example := range []struct {
|
|
name string
|
|
d LayoutDescriptor
|
|
hasTheme bool
|
|
layoutOverride string
|
|
f Format
|
|
}{
|
|
{`AMP home, with theme "demoTheme".`, LayoutDescriptor{Kind: "home"}, true, "", AMPFormat},
|
|
{"JSON home, no theme.", LayoutDescriptor{Kind: "home"}, false, "", JSONFormat},
|
|
{fmt.Sprintf(`CSV regular, "layout: %s" in front matter.`, demoLayout), LayoutDescriptor{Kind: "page", Layout: demoLayout}, false, "", CSVFormat},
|
|
{fmt.Sprintf(`JSON regular, "type: %s" in front matter.`, demoType), LayoutDescriptor{Kind: "page", Type: demoType}, false, "", CSVFormat},
|
|
{"HTML regular.", LayoutDescriptor{Kind: "page"}, false, "", HTMLFormat},
|
|
{"AMP regular.", LayoutDescriptor{Kind: "page"}, false, "", AMPFormat},
|
|
{"Calendar blog section.", LayoutDescriptor{Kind: "section", Section: "blog"}, false, "", CalendarFormat},
|
|
{"Calendar taxonomy list.", LayoutDescriptor{Kind: "taxonomy", Section: "tag"}, false, "", CalendarFormat},
|
|
{"Calendar taxonomy term.", LayoutDescriptor{Kind: "taxonomyTerm", Section: "tag"}, false, "", CalendarFormat},
|
|
} {
|
|
|
|
l := NewLayoutHandler(example.hasTheme)
|
|
layouts, _ := l.For(example.d, example.layoutOverride, example.f)
|
|
|
|
basicExamples = append(basicExamples, Example{
|
|
Example: example.name,
|
|
OutputFormat: example.f.Name,
|
|
Suffix: example.f.MediaType.Suffix,
|
|
Layouts: makeLayoutsPresentable(layouts)})
|
|
}
|
|
|
|
return basicExamples
|
|
|
|
}
|
|
|
|
func makeLayoutsPresentable(l []string) []string {
|
|
var filtered []string
|
|
for _, ll := range l {
|
|
ll = strings.TrimPrefix(ll, "_text/")
|
|
if strings.Contains(ll, "theme/") {
|
|
ll = strings.Replace(ll, "theme/", "demoTheme/layouts/", -1)
|
|
} else {
|
|
ll = "layouts/" + ll
|
|
}
|
|
if !strings.Contains(ll, "indexes") {
|
|
filtered = append(filtered, ll)
|
|
}
|
|
}
|
|
|
|
return filtered
|
|
}
|