github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-21 20:46:30 -05:00
Code Issues Projects Releases Packages Wiki Activity
hugo/output/docshelper.go

104 lines
4.1 KiB
Go
Raw Normal View History

all: Document the Output Formats feature 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
2017-04-05 10:18:53 -04:00
package output
import (
"strings"
output: Redo the docshelper layouts examples
2018-01-18 04:16:21 -05:00
// "fmt"
all: Document the Output Formats feature 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
2017-04-05 10:18:53 -04:00
all: Update import paths to gohugoio/hugo
2017-06-13 12:42:45 -04:00
"github.com/gohugoio/hugo/docshelper"
all: Document the Output Formats feature 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
2017-04-05 10:18:53 -04:00
)
// This is is just some helpers used to create some JSON used in the Hugo docs.
func init() {
Some minify configuration adjustments
2020-03-20 11:34:53 -04:00
docsProvider := func() docshelper.DocProvider {
return docshelper.DocProvider{
"output": map[string]interface{}{
"formats": DefaultFormats,
"layouts": createLayoutExamples(),
},
}
all: Document the Output Formats feature 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
2017-04-05 10:18:53 -04:00
}
Some minify configuration adjustments
2020-03-20 11:34:53 -04:00
docshelper.AddDocProviderFunc(docsProvider)
all: Document the Output Formats feature 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
2017-04-05 10:18:53 -04:00
}
func createLayoutExamples() interface{} {
type Example struct {
Example string
output: Redo the docshelper layouts examples
2018-01-18 04:16:21 -05:00
Kind string
all: Document the Output Formats feature 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
2017-04-05 10:18:53 -04:00
OutputFormat string
Suffix string
Layouts []string `json:"Template Lookup Order"`
}
var (
basicExamples []Example
demoLayout = "demolayout"
demoType = "demotype"
)
for _, example := range []struct {
docs: Update theme documentation See #4460
2018-06-12 01:38:41 -04:00
name string
d LayoutDescriptor
f Format
all: Document the Output Formats feature 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
2017-04-05 10:18:53 -04:00
}{
output: Redo the docshelper layouts examples
2018-01-18 04:16:21 -05:00
// Taxonomy output.LayoutDescriptor={categories category taxonomy en false Type Section
docs: Update theme documentation See #4460
2018-06-12 01:38:41 -04:00
{"Single page in \"posts\" section", LayoutDescriptor{Kind: "page", Type: "posts"}, HTMLFormat},
docs, output: Add base template lookup variant to docs.json
2020-01-23 05:59:52 -05:00
{"Base template for single page in \"posts\" section", LayoutDescriptor{Baseof: true, Kind: "page", Type: "posts"}, HTMLFormat},
docs: Update theme documentation See #4460
2018-06-12 01:38:41 -04:00
{"Single page in \"posts\" section with layout set", LayoutDescriptor{Kind: "page", Type: "posts", Layout: demoLayout}, HTMLFormat},
docs, output: Add base template lookup variant to docs.json
2020-01-23 05:59:52 -05:00
{"Base template for single page in \"posts\" section with layout set", LayoutDescriptor{Baseof: true, Kind: "page", Type: "posts", Layout: demoLayout}, HTMLFormat},
docs: Update theme documentation See #4460
2018-06-12 01:38:41 -04:00
{"AMP single page", LayoutDescriptor{Kind: "page", Type: "posts"}, AMPFormat},
{"AMP single page, French language", LayoutDescriptor{Kind: "page", Type: "posts", Lang: "fr"}, AMPFormat},
output: Redo the docshelper layouts examples
2018-01-18 04:16:21 -05:00
// All section or typeless pages gets "page" as type
docs: Update theme documentation See #4460
2018-06-12 01:38:41 -04:00
{"Home page", LayoutDescriptor{Kind: "home", Type: "page"}, HTMLFormat},
docs, output: Add base template lookup variant to docs.json
2020-01-23 05:59:52 -05:00
{"Base template for home page", LayoutDescriptor{Baseof: true, Kind: "home", Type: "page"}, HTMLFormat},
docs: Update theme documentation See #4460
2018-06-12 01:38:41 -04:00
{"Home page with type set", LayoutDescriptor{Kind: "home", Type: demoType}, HTMLFormat},
docs, output: Add base template lookup variant to docs.json
2020-01-23 05:59:52 -05:00
{"Base template for home page with type set", LayoutDescriptor{Baseof: true, Kind: "home", Type: demoType}, HTMLFormat},
docs: Update theme documentation See #4460
2018-06-12 01:38:41 -04:00
{"Home page with layout set", LayoutDescriptor{Kind: "home", Type: "page", Layout: demoLayout}, HTMLFormat},
{`AMP home, French language"`, LayoutDescriptor{Kind: "home", Type: "page", Lang: "fr"}, AMPFormat},
{"JSON home", LayoutDescriptor{Kind: "home", Type: "page"}, JSONFormat},
{"RSS home", LayoutDescriptor{Kind: "home", Type: "page"}, RSSFormat},
{"RSS section posts", LayoutDescriptor{Kind: "section", Type: "posts"}, RSSFormat},
{"Taxonomy list in categories", LayoutDescriptor{Kind: "taxonomy", Type: "categories", Section: "category"}, RSSFormat},
{"Taxonomy terms in categories", LayoutDescriptor{Kind: "taxonomyTerm", Type: "categories", Section: "category"}, RSSFormat},
{"Section list for \"posts\" section", LayoutDescriptor{Kind: "section", Type: "posts", Section: "posts"}, HTMLFormat},
{"Section list for \"posts\" section with type set to \"blog\"", LayoutDescriptor{Kind: "section", Type: "blog", Section: "posts"}, HTMLFormat},
{"Section list for \"posts\" section with layout set to \"demoLayout\"", LayoutDescriptor{Kind: "section", Layout: demoLayout, Section: "posts"}, HTMLFormat},
{"Taxonomy list in categories", LayoutDescriptor{Kind: "taxonomy", Type: "categories", Section: "category"}, HTMLFormat},
{"Taxonomy term in categories", LayoutDescriptor{Kind: "taxonomyTerm", Type: "categories", Section: "category"}, HTMLFormat},
all: Document the Output Formats feature 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
2017-04-05 10:18:53 -04:00
} {
Add support for theme composition and inheritance This commit adds support for theme composition and inheritance in Hugo. With this, it helps thinking about a theme as a set of ordered components: ```toml theme = ["my-shortcodes", "base-theme", "hyde"] ``` The theme definition example above in `config.toml` creates a theme with the 3 components with presedence from left to right. So, Hugo will, for any given file, data entry etc., look first in the project, and then in `my-shortcode`, `base-theme` and lastly `hyde`. Hugo uses two different algorithms to merge the filesystems, depending on the file type: * For `i18n` and `data` files, Hugo merges deeply using the translation id and data key inside the files. * For `static`, `layouts` (templates) and `archetypes` files, these are merged on file level. So the left-most file will be chosen. The name used in the `theme` definition above must match a folder in `/your-site/themes`, e.g. `/your-site/themes/my-shortcodes`. There are plans to improve on this and get a URL scheme so this can be resolved automatically. Also note that a component that is part of a theme can have its own configuration file, e.g. `config.toml`. There are currently some restrictions to what a theme component can configure: * `params` (global and per language) * `menu` (global and per language) * `outputformats` and `mediatypes` The same rules apply here: The left-most param/menu etc. with the same ID will win. There are some hidden and experimental namespace support in the above, which we will work to improve in the future, but theme authors are encouraged to create their own namespaces to avoid naming conflicts. A final note: Themes/components can also have a `theme` definition in their `config.toml` and similar, which is the "inheritance" part of this commit's title. This is currently not supported by the Hugo theme site. We will have to wait for some "auto dependency" feature to be implemented for that to happen, but this can be a powerful feature if you want to create your own theme-variant based on others. Fixes #4460 Fixes #4450
2018-03-01 09:01:25 -05:00
l := NewLayoutHandler()
layout: Respect Type and Layout for list template selection This commit also has some other nice side-effects: * The layout logic is unified for all page types, which should make it less surprising * Page.Render now supports all types * The legacy "indexes" type is removed from the template lookup order. This is an undocumented type from early Hugo days. This means that having a template in, say, `/layouts/indexes/list.html` will no longer work. * The theme override logic is improved. As an example, an `index.html` in theme will now wn over a `_default/list.html` in the project, which most will expect. Fixes #3005 Fixes #3245
2018-01-13 11:21:42 -05:00
layouts, _ := l.For(example.d, example.f)
all: Document the Output Formats feature 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
2017-04-05 10:18:53 -04:00
basicExamples = append(basicExamples, Example{
Example: example.name,
output: Redo the docshelper layouts examples
2018-01-18 04:16:21 -05:00
Kind: example.d.Kind,
all: Document the Output Formats feature 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
2017-04-05 10:18:53 -04:00
OutputFormat: example.f.Name,
media: Allow multiple file suffixes per media type Before this commit, `Suffix` on `MediaType` was used both to set a custom file suffix and as a way to augment the mediatype definition (what you see after the "+", e.g. "image/svg+xml"). This had its limitations. For one, it was only possible with one file extension per MIME type. Now you can specify multiple file suffixes using "suffixes", but you need to specify the full MIME type identifier: [mediaTypes] [mediaTypes."image/svg+xml"] suffixes = ["svg", "abc ] In most cases, it will be enough to just change: [mediaTypes] [mediaTypes."my/custom-mediatype"] suffix = "txt" To: [mediaTypes] [mediaTypes."my/custom-mediatype"] suffixes = ["txt"] Hugo will still respect values set in "suffix" if no value for "suffixes" is provided, but this will be removed in a future release. Note that you can still get the Media Type's suffix from a template: {{ $mediaType.Suffix }}. But this will now map to the MIME type filename. Fixes #4920
2018-07-10 05:55:22 -04:00
Suffix: example.f.MediaType.Suffix(),
all: Document the Output Formats feature 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
2017-04-05 10:18:53 -04:00
Layouts: makeLayoutsPresentable(layouts)})
}
return basicExamples
}
func makeLayoutsPresentable(l []string) []string {
var filtered []string
for _, ll := range l {
outputs: Adjust the layout examples
2018-03-09 07:26:28 -05:00
if strings.Contains(ll, "page/") {
// This is a valid lookup, but it's more confusing than useful.
continue
}
docs: Update theme documentation See #4460
2018-06-12 01:38:41 -04:00
ll = "layouts/" + strings.TrimPrefix(ll, "_text/")
all: Document the Output Formats feature 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
2017-04-05 10:18:53 -04:00
if !strings.Contains(ll, "indexes") {
filtered = append(filtered, ll)
}
}
return filtered
}
Reference in a new issue Copy permalink