2018-04-09 13:36:10 -04:00
|
|
|
// Copyright 2018 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 commands
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"bytes"
|
2018-06-11 03:42:37 -04:00
|
|
|
"errors"
|
|
|
|
|
"path/filepath"
|
2018-04-09 13:36:10 -04:00
|
|
|
"strings"
|
|
|
|
|
"time"
|
|
|
|
|
|
|
|
|
|
"github.com/gohugoio/hugo/helpers"
|
2018-06-11 03:42:37 -04:00
|
|
|
"github.com/gohugoio/hugo/hugofs"
|
2018-04-09 13:36:10 -04:00
|
|
|
"github.com/spf13/cobra"
|
|
|
|
|
jww "github.com/spf13/jwalterweatherman"
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
var _ cmder = (*newThemeCmd)(nil)
|
|
|
|
|
|
|
|
|
|
type newThemeCmd struct {
|
2020-01-31 03:09:11 -05:00
|
|
|
*baseBuilderCmd
|
2018-04-09 13:36:10 -04:00
|
|
|
}
|
|
|
|
|
|
2020-01-31 03:09:11 -05:00
|
|
|
func (b *commandsBuilder) newNewThemeCmd() *newThemeCmd {
|
|
|
|
|
cc := &newThemeCmd{}
|
2018-04-09 13:36:10 -04:00
|
|
|
|
|
|
|
|
cmd := &cobra.Command{
|
|
|
|
|
Use: "theme [name]",
|
|
|
|
|
Short: "Create a new theme",
|
|
|
|
|
Long: `Create a new theme (skeleton) called [name] in the current directory.
|
|
|
|
|
New theme is a skeleton. Please add content to the touched files. Add your
|
|
|
|
|
name to the copyright line in the license and adjust the theme.toml file
|
|
|
|
|
as you see fit.`,
|
2020-01-31 03:09:11 -05:00
|
|
|
RunE: cc.newTheme,
|
2018-04-09 13:36:10 -04:00
|
|
|
}
|
|
|
|
|
|
2020-01-31 03:09:11 -05:00
|
|
|
cc.baseBuilderCmd = b.newBuilderBasicCmd(cmd)
|
2018-04-09 13:36:10 -04:00
|
|
|
|
2020-01-31 03:09:11 -05:00
|
|
|
return cc
|
2018-04-09 13:36:10 -04:00
|
|
|
}
|
|
|
|
|
|
2018-06-11 03:42:37 -04:00
|
|
|
// newTheme creates a new Hugo theme template
|
2018-04-09 13:36:10 -04:00
|
|
|
func (n *newThemeCmd) newTheme(cmd *cobra.Command, args []string) error {
|
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
|
|
|
c, err := initializeConfig(false, false, &n.hugoBuilderCommon, n, nil)
|
2018-04-09 13:36:10 -04:00
|
|
|
|
|
|
|
|
if err != nil {
|
|
|
|
|
return err
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if len(args) < 1 {
|
|
|
|
|
return newUserError("theme name needs to be provided")
|
|
|
|
|
}
|
|
|
|
|
|
2019-08-15 03:33:47 -04:00
|
|
|
createpath := c.hugo().PathSpec.AbsPathify(filepath.Join(c.Cfg.GetString("themesDir"), args[0]))
|
2018-06-11 03:42:37 -04:00
|
|
|
jww.FEEDBACK.Println("Creating theme at", createpath)
|
2018-04-09 13:36:10 -04:00
|
|
|
|
|
|
|
|
cfg := c.DepsCfg
|
|
|
|
|
|
|
|
|
|
if x, _ := helpers.Exists(createpath, cfg.Fs.Source); x {
|
2018-06-11 03:42:37 -04:00
|
|
|
return errors.New(createpath + " already exists")
|
2018-04-09 13:36:10 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
mkdir(createpath, "layouts", "_default")
|
|
|
|
|
mkdir(createpath, "layouts", "partials")
|
|
|
|
|
|
|
|
|
|
touchFile(cfg.Fs.Source, createpath, "layouts", "index.html")
|
|
|
|
|
touchFile(cfg.Fs.Source, createpath, "layouts", "404.html")
|
|
|
|
|
touchFile(cfg.Fs.Source, createpath, "layouts", "_default", "list.html")
|
|
|
|
|
touchFile(cfg.Fs.Source, createpath, "layouts", "_default", "single.html")
|
|
|
|
|
|
2018-06-25 05:38:44 -04:00
|
|
|
baseofDefault := []byte(`<!DOCTYPE html>
|
|
|
|
|
<html>
|
2018-06-11 03:46:36 -04:00
|
|
|
{{- partial "head.html" . -}}
|
|
|
|
|
<body>
|
|
|
|
|
{{- partial "header.html" . -}}
|
|
|
|
|
<div id="content">
|
|
|
|
|
{{- block "main" . }}{{- end }}
|
|
|
|
|
</div>
|
|
|
|
|
{{- partial "footer.html" . -}}
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
|
|
|
|
`)
|
|
|
|
|
err = helpers.WriteToDisk(filepath.Join(createpath, "layouts", "_default", "baseof.html"), bytes.NewReader(baseofDefault), cfg.Fs.Source)
|
|
|
|
|
if err != nil {
|
|
|
|
|
return err
|
|
|
|
|
}
|
|
|
|
|
|
2018-06-25 05:39:20 -04:00
|
|
|
touchFile(cfg.Fs.Source, createpath, "layouts", "partials", "head.html")
|
2018-04-09 13:36:10 -04:00
|
|
|
touchFile(cfg.Fs.Source, createpath, "layouts", "partials", "header.html")
|
|
|
|
|
touchFile(cfg.Fs.Source, createpath, "layouts", "partials", "footer.html")
|
|
|
|
|
|
|
|
|
|
mkdir(createpath, "archetypes")
|
|
|
|
|
|
|
|
|
|
archDefault := []byte("+++\n+++\n")
|
|
|
|
|
|
|
|
|
|
err = helpers.WriteToDisk(filepath.Join(createpath, "archetypes", "default.md"), bytes.NewReader(archDefault), cfg.Fs.Source)
|
|
|
|
|
if err != nil {
|
|
|
|
|
return err
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
mkdir(createpath, "static", "js")
|
|
|
|
|
mkdir(createpath, "static", "css")
|
|
|
|
|
|
|
|
|
|
by := []byte(`The MIT License (MIT)
|
|
|
|
|
|
|
|
|
|
Copyright (c) ` + time.Now().Format("2006") + ` YOUR_NAME_HERE
|
|
|
|
|
|
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
|
|
|
this software and associated documentation files (the "Software"), to deal in
|
|
|
|
|
the Software without restriction, including without limitation the rights to
|
|
|
|
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
|
|
|
the Software, and to permit persons to whom the Software is furnished to do so,
|
|
|
|
|
subject to the following conditions:
|
|
|
|
|
|
|
|
|
|
The above copyright notice and this permission notice shall be included in all
|
|
|
|
|
copies or substantial portions of the Software.
|
|
|
|
|
|
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
|
|
|
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
|
|
|
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
|
|
|
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
|
|
|
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
|
|
|
`)
|
|
|
|
|
|
2018-06-11 03:54:49 -04:00
|
|
|
err = helpers.WriteToDisk(filepath.Join(createpath, "LICENSE"), bytes.NewReader(by), cfg.Fs.Source)
|
2018-04-09 13:36:10 -04:00
|
|
|
if err != nil {
|
|
|
|
|
return err
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
n.createThemeMD(cfg.Fs, createpath)
|
|
|
|
|
|
|
|
|
|
return nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (n *newThemeCmd) createThemeMD(fs *hugofs.Fs, inpath string) (err error) {
|
|
|
|
|
|
|
|
|
|
by := []byte(`# theme.toml template for a Hugo theme
|
|
|
|
|
# See https://github.com/gohugoio/hugoThemes#themetoml for an example
|
|
|
|
|
|
|
|
|
|
name = "` + strings.Title(helpers.MakeTitle(filepath.Base(inpath))) + `"
|
|
|
|
|
license = "MIT"
|
2018-06-11 03:54:49 -04:00
|
|
|
licenselink = "https://github.com/yourname/yourtheme/blob/master/LICENSE"
|
2018-04-09 13:36:10 -04:00
|
|
|
description = ""
|
|
|
|
|
homepage = "http://example.com/"
|
|
|
|
|
tags = []
|
|
|
|
|
features = []
|
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
|
|
|
min_version = "0.41"
|
2018-04-09 13:36:10 -04:00
|
|
|
|
|
|
|
|
[author]
|
|
|
|
|
name = ""
|
|
|
|
|
homepage = ""
|
|
|
|
|
|
|
|
|
|
# If porting an existing theme
|
|
|
|
|
[original]
|
|
|
|
|
name = ""
|
|
|
|
|
homepage = ""
|
|
|
|
|
repo = ""
|
|
|
|
|
`)
|
|
|
|
|
|
|
|
|
|
err = helpers.WriteToDisk(filepath.Join(inpath, "theme.toml"), bytes.NewReader(by), fs.Source)
|
|
|
|
|
if err != nil {
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return nil
|
|
|
|
|
}
|
