mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-21 20:46:30 -05:00
662e12f348
This commit completes the "The Revival of the Archetypes!"
If `.Site` is used in the arcetype template, the site is built and added to the template context.
Note that this may be potentially time consuming for big sites.
A more complete example would then be for the section `newsletter` and the archetype file `archetypes/newsletter.md`:
```
---
title: "{{ replace .TranslationBaseName "-" " " | title }}"
date: {{ .Date }}
tags:
- x
categories:
- x
draft: true
---
<!--more-->
{{ range first 10 ( where .Site.RegularPages "Type" "cool" ) }}
* {{ .Title }}
{{ end }}
```
And then create a new post with:
```bash
hugo new newsletter/the-latest-cool.stuff.md
```
**Hot Tip:** If you set the `newContentEditor` configuration variable to an editor on your `PATH`, the newly created article will be opened.
The above _newsletter type archetype_ illustrates the possibilities: The full Hugo `.Site` and all of Hugo's template funcs can be used in the archetype file.
Fixes #1629
119 lines
3.7 KiB
Go
119 lines
3.7 KiB
Go
// Copyright 2016-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 helpers
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/gohugoio/hugo/config"
|
|
"github.com/gohugoio/hugo/hugofs"
|
|
)
|
|
|
|
// PathSpec holds methods that decides how paths in URLs and files in Hugo should look like.
|
|
type PathSpec struct {
|
|
BaseURL
|
|
|
|
disablePathToLower bool
|
|
removePathAccents bool
|
|
uglyURLs bool
|
|
canonifyURLs bool
|
|
|
|
language *Language
|
|
|
|
// pagination path handling
|
|
paginatePath string
|
|
|
|
theme string
|
|
|
|
// Directories
|
|
themesDir string
|
|
layoutDir string
|
|
workingDir string
|
|
staticDir string
|
|
|
|
// The PathSpec looks up its config settings in both the current language
|
|
// and then in the global Viper config.
|
|
// Some settings, the settings listed below, does not make sense to be set
|
|
// on per-language-basis. We have no good way of protecting against this
|
|
// other than a "white-list". See language.go.
|
|
defaultContentLanguageInSubdir bool
|
|
defaultContentLanguage string
|
|
multilingual bool
|
|
|
|
// The file systems to use
|
|
Fs *hugofs.Fs
|
|
|
|
// The config provider to use
|
|
Cfg config.Provider
|
|
}
|
|
|
|
func (p PathSpec) String() string {
|
|
return fmt.Sprintf("PathSpec, language %q, prefix %q, multilingual: %T", p.language.Lang, p.getLanguagePrefix(), p.multilingual)
|
|
}
|
|
|
|
// NewPathSpec creats a new PathSpec from the given filesystems and Language.
|
|
func NewPathSpec(fs *hugofs.Fs, cfg config.Provider) (*PathSpec, error) {
|
|
|
|
baseURLstr := cfg.GetString("baseURL")
|
|
baseURL, err := newBaseURLFromString(baseURLstr)
|
|
|
|
if err != nil {
|
|
return nil, fmt.Errorf("Failed to create baseURL from %q: %s", baseURLstr, err)
|
|
}
|
|
|
|
ps := &PathSpec{
|
|
Fs: fs,
|
|
Cfg: cfg,
|
|
disablePathToLower: cfg.GetBool("disablePathToLower"),
|
|
removePathAccents: cfg.GetBool("removePathAccents"),
|
|
uglyURLs: cfg.GetBool("uglyURLs"),
|
|
canonifyURLs: cfg.GetBool("canonifyURLs"),
|
|
multilingual: cfg.GetBool("multilingual"),
|
|
defaultContentLanguageInSubdir: cfg.GetBool("defaultContentLanguageInSubdir"),
|
|
defaultContentLanguage: cfg.GetString("defaultContentLanguage"),
|
|
paginatePath: cfg.GetString("paginatePath"),
|
|
BaseURL: baseURL,
|
|
themesDir: cfg.GetString("themesDir"),
|
|
layoutDir: cfg.GetString("layoutDir"),
|
|
workingDir: cfg.GetString("workingDir"),
|
|
staticDir: cfg.GetString("staticDir"),
|
|
theme: cfg.GetString("theme"),
|
|
}
|
|
|
|
if language, ok := cfg.(*Language); ok {
|
|
ps.language = language
|
|
}
|
|
|
|
return ps, nil
|
|
}
|
|
|
|
// PaginatePath returns the configured root path used for paginator pages.
|
|
func (p *PathSpec) PaginatePath() string {
|
|
return p.paginatePath
|
|
}
|
|
|
|
// WorkingDir returns the configured workingDir.
|
|
func (p *PathSpec) WorkingDir() string {
|
|
return p.workingDir
|
|
}
|
|
|
|
// LayoutDir returns the relative layout dir in the currenct Hugo project.
|
|
func (p *PathSpec) LayoutDir() string {
|
|
return p.layoutDir
|
|
}
|
|
|
|
// Theme returns the theme name if set.
|
|
func (p *PathSpec) Theme() string {
|
|
return p.theme
|
|
}
|