diff options
Diffstat (limited to 'media/type.go')
-rw-r--r-- | media/type.go | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/media/type.go b/media/type.go new file mode 100644 index 000000000..701f8f4e1 --- /dev/null +++ b/media/type.go @@ -0,0 +1,65 @@ +// Copyright 2017-present 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 media + +import ( + "fmt" +) + +type Types []Type + +// A media type (also known as MIME type and content type) is a two-part identifier for +// file formats and format contents transmitted on the Internet. +// For Hugo's use case, we use the top-level type name / subtype name + suffix. +// One example would be image/jpeg+jpg +// If suffix is not provided, the sub type will be used. +// See // https://en.wikipedia.org/wiki/Media_type +type Type struct { + Type string // i.e. text + SubType string // i.e. html + Suffix string // i.e html +} + +// Key return a key used to identify this media type. Hugo will register a set of +// default media types. These can be overridden by the user in the configuration, +// by defining a media type with the same Key. +func (m Type) Key() string { + if m.Suffix != "" { + return fmt.Sprintf("%s/%s+%s", m.Type, m.SubType, m.Suffix) + } + return fmt.Sprintf("%s/%s", m.Type, m.SubType) +} + +func (m Type) String() string { + return m.Key() +} + +var ( + HtmlType = Type{"text", "html", "html"} + RSSType = Type{"application", "rss", "xml"} +) + +// DefaultMediaTypes holds a default set of media types by Hugo. +// These can be ovverriden, and more added if needed, in the Hugo configuration file. +// The final media type set set will also be added as extensions to mime so +// they will be recognised by the built-in server in Hugo. +var DefaultMediaTypes = Types{ + HtmlType, + RSSType, + + // TODO(bep) output +} + +// TODO(bep) output mime.AddExtensionType +// TODO(bep) text/template vs html/template |