mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-07 20:30:36 -05:00
597e418cb0
The main motivation of this commit is to add a `page.Page` interface to replace the very file-oriented `hugolib.Page` struct. This is all a preparation step for issue #5074, "pages from other data sources". But this also fixes a set of annoying limitations, especially related to custom output formats, and shortcodes. Most notable changes: * The inner content of shortcodes using the `{{%` as the outer-most delimiter will now be sent to the content renderer, e.g. Blackfriday. This means that any markdown will partake in the global ToC and footnote context etc. * The Custom Output formats are now "fully virtualized". This removes many of the current limitations. * The taxonomy list type now has a reference to the `Page` object. This improves the taxonomy template `.Title` situation and make common template constructs much simpler. See #5074 Fixes #5763 Fixes #5758 Fixes #5090 Fixes #5204 Fixes #4695 Fixes #5607 Fixes #5707 Fixes #5719 Fixes #3113 Fixes #5706 Fixes #5767 Fixes #5723 Fixes #5769 Fixes #5770 Fixes #5771 Fixes #5759 Fixes #5776 Fixes #5777 Fixes #5778
91 lines
2.6 KiB
Go
91 lines
2.6 KiB
Go
// Copyright 2019 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 hugolib
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/gohugoio/hugo/config"
|
|
"github.com/gohugoio/hugo/output"
|
|
"github.com/gohugoio/hugo/resources/page"
|
|
"github.com/spf13/cast"
|
|
)
|
|
|
|
func createDefaultOutputFormats(allFormats output.Formats, cfg config.Provider) map[string]output.Formats {
|
|
rssOut, _ := allFormats.GetByName(output.RSSFormat.Name)
|
|
htmlOut, _ := allFormats.GetByName(output.HTMLFormat.Name)
|
|
robotsOut, _ := allFormats.GetByName(output.RobotsTxtFormat.Name)
|
|
sitemapOut, _ := allFormats.GetByName(output.SitemapFormat.Name)
|
|
|
|
return map[string]output.Formats{
|
|
page.KindPage: {htmlOut},
|
|
page.KindHome: {htmlOut, rssOut},
|
|
page.KindSection: {htmlOut, rssOut},
|
|
page.KindTaxonomy: {htmlOut, rssOut},
|
|
page.KindTaxonomyTerm: {htmlOut, rssOut},
|
|
// Below are for conistency. They are currently not used during rendering.
|
|
kindRSS: {rssOut},
|
|
kindSitemap: {sitemapOut},
|
|
kindRobotsTXT: {robotsOut},
|
|
kind404: {htmlOut},
|
|
}
|
|
|
|
}
|
|
|
|
func createSiteOutputFormats(allFormats output.Formats, cfg config.Provider) (map[string]output.Formats, error) {
|
|
defaultOutputFormats := createDefaultOutputFormats(allFormats, cfg)
|
|
|
|
if !cfg.IsSet("outputs") {
|
|
return defaultOutputFormats, nil
|
|
}
|
|
|
|
outFormats := make(map[string]output.Formats)
|
|
|
|
outputs := cfg.GetStringMap("outputs")
|
|
|
|
if len(outputs) == 0 {
|
|
return outFormats, nil
|
|
}
|
|
|
|
seen := make(map[string]bool)
|
|
|
|
for k, v := range outputs {
|
|
var formats output.Formats
|
|
vals := cast.ToStringSlice(v)
|
|
for _, format := range vals {
|
|
f, found := allFormats.GetByName(format)
|
|
if !found {
|
|
return nil, fmt.Errorf("failed to resolve output format %q from site config", format)
|
|
}
|
|
formats = append(formats, f)
|
|
}
|
|
|
|
// This effectively prevents empty outputs entries for a given Kind.
|
|
// We need at least one.
|
|
if len(formats) > 0 {
|
|
seen[k] = true
|
|
outFormats[k] = formats
|
|
}
|
|
}
|
|
|
|
// Add defaults for the entries not provided by the user.
|
|
for k, v := range defaultOutputFormats {
|
|
if !seen[k] {
|
|
outFormats[k] = v
|
|
}
|
|
}
|
|
|
|
return outFormats, nil
|
|
|
|
}
|