mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-21 20:46:30 -05:00
commands/new: Embed site and theme skeletons
The skeletons are used when creating new sites and themes with the CLI. Closes #11358
This commit is contained in:
parent
90944aa261
commit
b6538532f4
41 changed files with 465 additions and 203 deletions
|
@ -14,7 +14,6 @@
|
||||||
package commands
|
package commands
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"log"
|
"log"
|
||||||
|
@ -24,8 +23,6 @@ import (
|
||||||
|
|
||||||
"github.com/bep/simplecobra"
|
"github.com/bep/simplecobra"
|
||||||
"github.com/gohugoio/hugo/config"
|
"github.com/gohugoio/hugo/config"
|
||||||
"github.com/gohugoio/hugo/helpers"
|
|
||||||
"github.com/spf13/afero"
|
|
||||||
"github.com/spf13/pflag"
|
"github.com/spf13/pflag"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -123,11 +120,3 @@ func mkdir(x ...string) {
|
||||||
log.Fatal(err)
|
log.Fatal(err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func touchFile(fs afero.Fs, filename string) {
|
|
||||||
mkdir(filepath.Dir(filename))
|
|
||||||
err := helpers.WriteToDisk(filename, bytes.NewReader([]byte{}), fs)
|
|
||||||
if err != nil {
|
|
||||||
log.Fatal(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
205
commands/new.go
205
commands/new.go
|
@ -16,19 +16,13 @@ package commands
|
||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
"context"
|
"context"
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"github.com/bep/simplecobra"
|
"github.com/bep/simplecobra"
|
||||||
"github.com/gohugoio/hugo/common/htime"
|
|
||||||
"github.com/gohugoio/hugo/config"
|
"github.com/gohugoio/hugo/config"
|
||||||
"github.com/gohugoio/hugo/create"
|
"github.com/gohugoio/hugo/create"
|
||||||
"github.com/gohugoio/hugo/helpers"
|
"github.com/gohugoio/hugo/create/skeletons"
|
||||||
"github.com/gohugoio/hugo/parser"
|
|
||||||
"github.com/gohugoio/hugo/parser/metadecoders"
|
|
||||||
"github.com/spf13/afero"
|
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -99,52 +93,13 @@ Use ` + "`hugo new [contentPath]`" + ` to create new content.`,
|
||||||
}
|
}
|
||||||
sourceFs := conf.fs.Source
|
sourceFs := conf.fs.Source
|
||||||
|
|
||||||
archeTypePath := filepath.Join(createpath, "archetypes")
|
err = skeletons.CreateSite(createpath, sourceFs, force, format)
|
||||||
dirs := []string{
|
if err != nil {
|
||||||
archeTypePath,
|
return err
|
||||||
filepath.Join(createpath, "assets"),
|
|
||||||
filepath.Join(createpath, "content"),
|
|
||||||
filepath.Join(createpath, "data"),
|
|
||||||
filepath.Join(createpath, "layouts"),
|
|
||||||
filepath.Join(createpath, "static"),
|
|
||||||
filepath.Join(createpath, "themes"),
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if exists, _ := helpers.Exists(createpath, sourceFs); exists {
|
r.Printf("Congratulations! Your new Hugo site was created in %s.\n\n", createpath)
|
||||||
if isDir, _ := helpers.IsDir(createpath, sourceFs); !isDir {
|
r.Println(c.newSiteNextStepsText(createpath, format))
|
||||||
return errors.New(createpath + " already exists but not a directory")
|
|
||||||
}
|
|
||||||
|
|
||||||
isEmpty, _ := helpers.IsEmpty(createpath, sourceFs)
|
|
||||||
|
|
||||||
switch {
|
|
||||||
case !isEmpty && !force:
|
|
||||||
return errors.New(createpath + " already exists and is not empty. See --force.")
|
|
||||||
|
|
||||||
case !isEmpty && force:
|
|
||||||
all := append(dirs, filepath.Join(createpath, "hugo."+format))
|
|
||||||
for _, path := range all {
|
|
||||||
if exists, _ := helpers.Exists(path, sourceFs); exists {
|
|
||||||
return errors.New(path + " already exists")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, dir := range dirs {
|
|
||||||
if err := sourceFs.MkdirAll(dir, 0777); err != nil {
|
|
||||||
return fmt.Errorf("failed to create dir: %w", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
c.newSiteCreateConfig(sourceFs, createpath, format)
|
|
||||||
|
|
||||||
// Create a default archetype file.
|
|
||||||
helpers.SafeWriteToDisk(filepath.Join(archeTypePath, "default.md"),
|
|
||||||
strings.NewReader(create.DefaultArchetypeTemplateTemplate), sourceFs)
|
|
||||||
|
|
||||||
r.Printf("Congratulations! Your new Hugo site is created in %s.\n\n", createpath)
|
|
||||||
r.Println(c.newSiteNextStepsText())
|
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
},
|
},
|
||||||
|
@ -173,83 +128,13 @@ according to your needs.`,
|
||||||
sourceFs := ps.Fs.Source
|
sourceFs := ps.Fs.Source
|
||||||
themesDir := h.Configs.LoadingInfo.BaseConfig.ThemesDir
|
themesDir := h.Configs.LoadingInfo.BaseConfig.ThemesDir
|
||||||
createpath := ps.AbsPathify(filepath.Join(themesDir, args[0]))
|
createpath := ps.AbsPathify(filepath.Join(themesDir, args[0]))
|
||||||
r.Println("Creating theme at", createpath)
|
r.Println("Creating new theme in", createpath)
|
||||||
|
|
||||||
if x, _ := helpers.Exists(createpath, sourceFs); x {
|
err = skeletons.CreateTheme(createpath, sourceFs)
|
||||||
return errors.New(createpath + " already exists")
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, filename := range []string{
|
|
||||||
"index.html",
|
|
||||||
"404.html",
|
|
||||||
"_default/list.html",
|
|
||||||
"_default/single.html",
|
|
||||||
"partials/head.html",
|
|
||||||
"partials/header.html",
|
|
||||||
"partials/footer.html",
|
|
||||||
} {
|
|
||||||
touchFile(sourceFs, filepath.Join(createpath, "layouts", filename))
|
|
||||||
}
|
|
||||||
|
|
||||||
baseofDefault := []byte(`<!DOCTYPE html>
|
|
||||||
<html>
|
|
||||||
{{- 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), sourceFs)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
mkdir(createpath, "archetypes")
|
|
||||||
|
|
||||||
archDefault := []byte("+++\n+++\n")
|
|
||||||
|
|
||||||
err = helpers.WriteToDisk(filepath.Join(createpath, "archetypes", "default.md"), bytes.NewReader(archDefault), sourceFs)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
mkdir(createpath, "static", "js")
|
|
||||||
mkdir(createpath, "static", "css")
|
|
||||||
|
|
||||||
by := []byte(`The MIT License (MIT)
|
|
||||||
|
|
||||||
Copyright (c) ` + htime.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.
|
|
||||||
`)
|
|
||||||
|
|
||||||
err = helpers.WriteToDisk(filepath.Join(createpath, "LICENSE"), bytes.NewReader(by), sourceFs)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
c.createThemeMD(ps.Fs.Source, createpath)
|
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
@ -299,77 +184,25 @@ func (c *newCommand) PreRun(cd, runner *simplecobra.Commandeer) error {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *newCommand) newSiteCreateConfig(fs afero.Fs, inpath string, kind string) (err error) {
|
func (c *newCommand) newSiteNextStepsText(path string, format string) string {
|
||||||
in := map[string]string{
|
format = strings.ToLower(format)
|
||||||
"baseURL": "http://example.org/",
|
|
||||||
"title": "My New Hugo Site",
|
|
||||||
"languageCode": "en-us",
|
|
||||||
}
|
|
||||||
|
|
||||||
var buf bytes.Buffer
|
|
||||||
err = parser.InterfaceToConfig(in, metadecoders.FormatFromString(kind), &buf)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
return helpers.WriteToDisk(filepath.Join(inpath, "hugo."+kind), &buf, fs)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *newCommand) newSiteNextStepsText() string {
|
|
||||||
var nextStepsText bytes.Buffer
|
var nextStepsText bytes.Buffer
|
||||||
|
|
||||||
nextStepsText.WriteString(`Just a few more steps and you're ready to go:
|
nextStepsText.WriteString(`Just a few more steps...
|
||||||
|
|
||||||
1. Download a theme into the same-named folder.
|
1. Change the current directory to ` + path + `.
|
||||||
Choose a theme from https://themes.gohugo.io/ or
|
2. Create or install a theme:
|
||||||
create your own with the "hugo new theme <THEMENAME>" command.
|
- Create a new theme with the command "hugo new theme <THEMENAME>"
|
||||||
2. Perhaps you want to add some content. You can add single files
|
- Install a theme from https://themes.gohugo.io/
|
||||||
with "hugo new `)
|
3. Edit hugo.` + format + `, setting the "theme" property to the theme name.
|
||||||
|
4. Create new content with the command "hugo new content `)
|
||||||
|
|
||||||
nextStepsText.WriteString(filepath.Join("<SECTIONNAME>", "<FILENAME>.<FORMAT>"))
|
nextStepsText.WriteString(filepath.Join("<SECTIONNAME>", "<FILENAME>.<FORMAT>"))
|
||||||
|
|
||||||
nextStepsText.WriteString(`".
|
nextStepsText.WriteString(`".
|
||||||
3. Start the built-in live server via "hugo server".
|
5. Start the embedded web server with the command "hugo server --buildDrafts".
|
||||||
|
|
||||||
Visit https://gohugo.io/ for quickstart guide and full documentation.`)
|
See documentation at https://gohugo.io/.`)
|
||||||
|
|
||||||
return nextStepsText.String()
|
return nextStepsText.String()
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *newCommand) createThemeMD(fs afero.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"
|
|
||||||
licenselink = "https://github.com/yourname/yourtheme/blob/master/LICENSE"
|
|
||||||
description = ""
|
|
||||||
homepage = "http://example.com/"
|
|
||||||
tags = []
|
|
||||||
features = []
|
|
||||||
min_version = "0.116.0"
|
|
||||||
|
|
||||||
[author]
|
|
||||||
name = ""
|
|
||||||
homepage = ""
|
|
||||||
|
|
||||||
# If porting an existing theme
|
|
||||||
[original]
|
|
||||||
name = ""
|
|
||||||
homepage = ""
|
|
||||||
repo = ""
|
|
||||||
`)
|
|
||||||
|
|
||||||
err = helpers.WriteToDisk(filepath.Join(inpath, "theme.toml"), bytes.NewReader(by), fs)
|
|
||||||
if err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
err = helpers.WriteToDisk(filepath.Join(inpath, "hugo.toml"), strings.NewReader("# Theme config.\n"), fs)
|
|
||||||
if err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
|
@ -42,7 +42,7 @@ const (
|
||||||
// DefaultArchetypeTemplateTemplate is the template used in 'hugo new site'
|
// DefaultArchetypeTemplateTemplate is the template used in 'hugo new site'
|
||||||
// and the template we use as a fall back.
|
// and the template we use as a fall back.
|
||||||
DefaultArchetypeTemplateTemplate = `---
|
DefaultArchetypeTemplateTemplate = `---
|
||||||
title: "{{ replace .Name "-" " " | title }}"
|
title: "{{ replace .File.ContentBaseName "-" " " | title }}"
|
||||||
date: {{ .Date }}
|
date: {{ .Date }}
|
||||||
draft: true
|
draft: true
|
||||||
---
|
---
|
||||||
|
|
5
create/skeletons/site/archetypes/default.md
Normal file
5
create/skeletons/site/archetypes/default.md
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
+++
|
||||||
|
title = '{{ replace .File.ContentBaseName "-" " " | title }}'
|
||||||
|
date = {{ .Date }}
|
||||||
|
draft = true
|
||||||
|
+++
|
0
create/skeletons/site/assets/.gitkeep
Normal file
0
create/skeletons/site/assets/.gitkeep
Normal file
0
create/skeletons/site/content/.gitkeep
Normal file
0
create/skeletons/site/content/.gitkeep
Normal file
0
create/skeletons/site/data/.gitkeep
Normal file
0
create/skeletons/site/data/.gitkeep
Normal file
0
create/skeletons/site/i18n/.gitkeep
Normal file
0
create/skeletons/site/i18n/.gitkeep
Normal file
0
create/skeletons/site/layouts/.gitkeep
Normal file
0
create/skeletons/site/layouts/.gitkeep
Normal file
0
create/skeletons/site/static/.gitkeep
Normal file
0
create/skeletons/site/static/.gitkeep
Normal file
0
create/skeletons/site/themes/.gitkeep
Normal file
0
create/skeletons/site/themes/.gitkeep
Normal file
111
create/skeletons/skeletons.go
Normal file
111
create/skeletons/skeletons.go
Normal file
|
@ -0,0 +1,111 @@
|
||||||
|
// Copyright 2023 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 skeletons
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"embed"
|
||||||
|
"errors"
|
||||||
|
"io/fs"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/gohugoio/hugo/helpers"
|
||||||
|
"github.com/gohugoio/hugo/parser"
|
||||||
|
"github.com/gohugoio/hugo/parser/metadecoders"
|
||||||
|
"github.com/spf13/afero"
|
||||||
|
)
|
||||||
|
|
||||||
|
//go:embed all:site/*
|
||||||
|
var siteFs embed.FS
|
||||||
|
|
||||||
|
//go:embed all:theme/*
|
||||||
|
var themeFs embed.FS
|
||||||
|
|
||||||
|
// CreateTheme creates a theme skeleton.
|
||||||
|
func CreateTheme(createpath string, sourceFs afero.Fs) error {
|
||||||
|
if exists, _ := helpers.Exists(createpath, sourceFs); exists {
|
||||||
|
return errors.New(createpath + " already exists")
|
||||||
|
}
|
||||||
|
return copyFiles(createpath, sourceFs, themeFs)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CreateSite creates a site skeleton.
|
||||||
|
func CreateSite(createpath string, sourceFs afero.Fs, force bool, format string) error {
|
||||||
|
format = strings.ToLower(format)
|
||||||
|
if exists, _ := helpers.Exists(createpath, sourceFs); exists {
|
||||||
|
if isDir, _ := helpers.IsDir(createpath, sourceFs); !isDir {
|
||||||
|
return errors.New(createpath + " already exists but not a directory")
|
||||||
|
}
|
||||||
|
|
||||||
|
isEmpty, _ := helpers.IsEmpty(createpath, sourceFs)
|
||||||
|
|
||||||
|
switch {
|
||||||
|
case !isEmpty && !force:
|
||||||
|
return errors.New(createpath + " already exists and is not empty. See --force.")
|
||||||
|
case !isEmpty && force:
|
||||||
|
var all []string
|
||||||
|
fs.WalkDir(siteFs, ".", func(path string, d fs.DirEntry, err error) error {
|
||||||
|
if d.IsDir() && path != "." {
|
||||||
|
all = append(all, path)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
all = append(all, filepath.Join(createpath, "hugo."+format))
|
||||||
|
for _, path := range all {
|
||||||
|
if exists, _ := helpers.Exists(path, sourceFs); exists {
|
||||||
|
return errors.New(path + " already exists")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
err := newSiteCreateConfig(sourceFs, createpath, format)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return copyFiles(createpath, sourceFs, siteFs)
|
||||||
|
}
|
||||||
|
|
||||||
|
func copyFiles(createpath string, sourceFs afero.Fs, skeleton embed.FS) error {
|
||||||
|
return fs.WalkDir(skeleton, ".", func(path string, d fs.DirEntry, err error) error {
|
||||||
|
_, slug, _ := strings.Cut(path, "/")
|
||||||
|
if d.IsDir() {
|
||||||
|
return sourceFs.MkdirAll(filepath.Join(createpath, slug), 0777)
|
||||||
|
} else {
|
||||||
|
if filepath.Base(path) != ".gitkeep" {
|
||||||
|
data, _ := fs.ReadFile(skeleton, path)
|
||||||
|
return helpers.WriteToDisk(filepath.Join(createpath, slug), bytes.NewReader(data), sourceFs)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func newSiteCreateConfig(fs afero.Fs, createpath string, format string) (err error) {
|
||||||
|
in := map[string]string{
|
||||||
|
"baseURL": "https://example.org/",
|
||||||
|
"title": "My New Hugo Site",
|
||||||
|
"languageCode": "en-us",
|
||||||
|
}
|
||||||
|
|
||||||
|
var buf bytes.Buffer
|
||||||
|
err = parser.InterfaceToConfig(in, metadecoders.FormatFromString(format), &buf)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return helpers.WriteToDisk(filepath.Join(createpath, "hugo."+format), &buf, fs)
|
||||||
|
}
|
21
create/skeletons/theme/LICENSE
Normal file
21
create/skeletons/theme/LICENSE
Normal file
|
@ -0,0 +1,21 @@
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) [year] [fullname]
|
||||||
|
|
||||||
|
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.
|
7
create/skeletons/theme/README.md
Normal file
7
create/skeletons/theme/README.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
# Theme Name
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
## Configuration
|
5
create/skeletons/theme/archetypes/default.md
Normal file
5
create/skeletons/theme/archetypes/default.md
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
+++
|
||||||
|
title = '{{ replace .File.ContentBaseName "-" " " | title }}'
|
||||||
|
date = {{ .Date }}
|
||||||
|
draft = true
|
||||||
|
+++
|
22
create/skeletons/theme/assets/css/main.css
Normal file
22
create/skeletons/theme/assets/css/main.css
Normal file
|
@ -0,0 +1,22 @@
|
||||||
|
body {
|
||||||
|
color: #222;
|
||||||
|
font-family: sans-serif;
|
||||||
|
line-height: 1.5;
|
||||||
|
margin: 1rem;
|
||||||
|
max-width: 768px;
|
||||||
|
}
|
||||||
|
|
||||||
|
header {
|
||||||
|
border-bottom: 1px solid #222;
|
||||||
|
margin-bottom: 1rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
footer {
|
||||||
|
border-top: 1px solid #222;
|
||||||
|
margin-top: 1rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
a {
|
||||||
|
color: #00e;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
1
create/skeletons/theme/assets/js/main.js
Normal file
1
create/skeletons/theme/assets/js/main.js
Normal file
|
@ -0,0 +1 @@
|
||||||
|
console.log('This site was generated by Hugo.');
|
4
create/skeletons/theme/config/_default/hugo.toml
Normal file
4
create/skeletons/theme/config/_default/hugo.toml
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
[module]
|
||||||
|
[module.hugoVersion]
|
||||||
|
extended = false
|
||||||
|
min = "0.116.0"
|
14
create/skeletons/theme/config/_default/menus.toml
Normal file
14
create/skeletons/theme/config/_default/menus.toml
Normal file
|
@ -0,0 +1,14 @@
|
||||||
|
[[main]]
|
||||||
|
name = 'Home'
|
||||||
|
pageRef = '/'
|
||||||
|
weight = 10
|
||||||
|
|
||||||
|
[[main]]
|
||||||
|
name = 'Posts'
|
||||||
|
pageRef = '/posts'
|
||||||
|
weight = 20
|
||||||
|
|
||||||
|
[[main]]
|
||||||
|
name = 'Tags'
|
||||||
|
pageRef = '/tags'
|
||||||
|
weight = 30
|
9
create/skeletons/theme/content/_index.md
Normal file
9
create/skeletons/theme/content/_index.md
Normal file
|
@ -0,0 +1,9 @@
|
||||||
|
+++
|
||||||
|
title = 'Home'
|
||||||
|
date = 2023-01-01T08:00:00-07:00
|
||||||
|
draft = false
|
||||||
|
+++
|
||||||
|
|
||||||
|
Laborum voluptate pariatur ex culpa magna nostrud est incididunt fugiat
|
||||||
|
pariatur do dolor ipsum enim. Consequat tempor do dolor eu. Non id id anim anim
|
||||||
|
excepteur excepteur pariatur nostrud qui irure ullamco.
|
7
create/skeletons/theme/content/posts/_index.md
Normal file
7
create/skeletons/theme/content/posts/_index.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
+++
|
||||||
|
title = 'Posts'
|
||||||
|
date = 2023-01-01T08:30:00-07:00
|
||||||
|
draft = false
|
||||||
|
+++
|
||||||
|
|
||||||
|
Tempor est exercitation ad qui pariatur quis adipisicing aliquip nisi ea consequat ipsum occaecat. Nostrud consequat ullamco laboris fugiat esse esse adipisicing velit laborum ipsum incididunt ut enim. Dolor pariatur nulla quis fugiat dolore excepteur. Aliquip ad quis aliqua enim do consequat.
|
10
create/skeletons/theme/content/posts/post-1.md
Normal file
10
create/skeletons/theme/content/posts/post-1.md
Normal file
|
@ -0,0 +1,10 @@
|
||||||
|
+++
|
||||||
|
title = 'Post 1'
|
||||||
|
date = 2023-01-15T09:00:00-07:00
|
||||||
|
draft = false
|
||||||
|
tags = ['red']
|
||||||
|
+++
|
||||||
|
|
||||||
|
Tempor proident minim aliquip reprehenderit dolor et ad anim Lorem duis sint eiusmod. Labore ut ea duis dolor. Incididunt consectetur proident qui occaecat incididunt do nisi Lorem. Tempor do laborum elit laboris excepteur eiusmod do. Eiusmod nisi excepteur ut amet pariatur adipisicing Lorem.
|
||||||
|
|
||||||
|
Occaecat nulla excepteur dolore excepteur duis eiusmod ullamco officia anim in voluptate ea occaecat officia. Cillum sint esse velit ea officia minim fugiat. Elit ea esse id aliquip pariatur cupidatat id duis minim incididunt ea ea. Anim ut duis sunt nisi. Culpa cillum sit voluptate voluptate eiusmod dolor. Enim nisi Lorem ipsum irure est excepteur voluptate eu in enim nisi. Nostrud ipsum Lorem anim sint labore consequat do.
|
10
create/skeletons/theme/content/posts/post-2.md
Normal file
10
create/skeletons/theme/content/posts/post-2.md
Normal file
|
@ -0,0 +1,10 @@
|
||||||
|
+++
|
||||||
|
title = 'Post 2'
|
||||||
|
date = 2023-02-15T10:00:00-07:00
|
||||||
|
draft = false
|
||||||
|
tags = ['red','green']
|
||||||
|
+++
|
||||||
|
|
||||||
|
Anim eiusmod irure incididunt sint cupidatat. Incididunt irure irure irure nisi ipsum do ut quis fugiat consectetur proident cupidatat incididunt cillum. Dolore voluptate occaecat qui mollit laborum ullamco et. Ipsum laboris officia anim laboris culpa eiusmod ex magna ex cupidatat anim ipsum aute. Mollit aliquip occaecat qui sunt velit ut cupidatat reprehenderit enim sunt laborum. Velit veniam in officia nulla adipisicing ut duis officia.
|
||||||
|
|
||||||
|
Exercitation voluptate irure in irure tempor mollit Lorem nostrud ad officia. Velit id fugiat occaecat do tempor. Sit officia Lorem aliquip eu deserunt consectetur. Aute proident deserunt in nulla aliquip dolore ipsum Lorem ut cupidatat consectetur sit sint laborum. Esse cupidatat sit sint sunt tempor exercitation deserunt. Labore dolor duis laborum est do nisi ut veniam dolor et nostrud nostrud.
|
BIN
create/skeletons/theme/content/posts/post-3/bryce-canyon.jpg
Normal file
BIN
create/skeletons/theme/content/posts/post-3/bryce-canyon.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 19 KiB |
12
create/skeletons/theme/content/posts/post-3/index.md
Normal file
12
create/skeletons/theme/content/posts/post-3/index.md
Normal file
|
@ -0,0 +1,12 @@
|
||||||
|
+++
|
||||||
|
title = 'Post 3'
|
||||||
|
date = 2023-03-15T11:00:00-07:00
|
||||||
|
draft = false
|
||||||
|
tags = ['red','green','blue']
|
||||||
|
+++
|
||||||
|
|
||||||
|
Occaecat aliqua consequat laborum ut ex aute aliqua culpa quis irure esse magna dolore quis. Proident fugiat labore eu laboris officia Lorem enim. Ipsum occaecat cillum ut tempor id sint aliqua incididunt nisi incididunt reprehenderit. Voluptate ad minim sint est aute aliquip esse occaecat tempor officia qui sunt. Aute ex ipsum id ut in est velit est laborum incididunt. Aliqua qui id do esse sunt eiusmod id deserunt eu nostrud aute sit ipsum. Deserunt esse cillum Lorem non magna adipisicing mollit amet consequat.
|
||||||
|
|
||||||
|
![Bryce Canyon National Park](bryce-canyon.jpg)
|
||||||
|
|
||||||
|
Sit excepteur do velit veniam mollit in nostrud laboris incididunt ea. Amet eu cillum ut reprehenderit culpa aliquip labore laborum amet sit sit duis. Laborum id proident nostrud dolore laborum reprehenderit quis mollit nulla amet veniam officia id id. Aliquip in deserunt qui magna duis qui pariatur officia sunt deserunt.
|
0
create/skeletons/theme/data/.gitkeep
Normal file
0
create/skeletons/theme/data/.gitkeep
Normal file
0
create/skeletons/theme/i18n/.gitkeep
Normal file
0
create/skeletons/theme/i18n/.gitkeep
Normal file
17
create/skeletons/theme/layouts/_default/baseof.html
Normal file
17
create/skeletons/theme/layouts/_default/baseof.html
Normal file
|
@ -0,0 +1,17 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="{{ or site.Language.LanguageCode site.Language.Lang }}" dir="{{ or site.Language.LanguageDirection `ltr` }}">
|
||||||
|
<head>
|
||||||
|
{{ partial "head.html" . }}
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<header>
|
||||||
|
{{ partial "header.html" . }}
|
||||||
|
</header>
|
||||||
|
<main>
|
||||||
|
{{ block "main" . }}{{ end }}
|
||||||
|
</main>
|
||||||
|
<footer>
|
||||||
|
{{ partial "footer.html" . }}
|
||||||
|
</footer>
|
||||||
|
</body>
|
||||||
|
</html>
|
7
create/skeletons/theme/layouts/_default/home.html
Normal file
7
create/skeletons/theme/layouts/_default/home.html
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
{{ define "main" }}
|
||||||
|
{{ .Content }}
|
||||||
|
{{ range site.RegularPages }}
|
||||||
|
<h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
|
||||||
|
{{ .Summary }}
|
||||||
|
{{ end }}
|
||||||
|
{{ end }}
|
8
create/skeletons/theme/layouts/_default/list.html
Normal file
8
create/skeletons/theme/layouts/_default/list.html
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
{{ define "main" }}
|
||||||
|
<h1>{{ .Title }}</h1>
|
||||||
|
{{ .Content }}
|
||||||
|
{{ range .Pages }}
|
||||||
|
<h2><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></h2>
|
||||||
|
{{ .Summary }}
|
||||||
|
{{ end }}
|
||||||
|
{{ end }}
|
10
create/skeletons/theme/layouts/_default/single.html
Normal file
10
create/skeletons/theme/layouts/_default/single.html
Normal file
|
@ -0,0 +1,10 @@
|
||||||
|
{{ define "main" }}
|
||||||
|
<h1>{{ .Title }}</h1>
|
||||||
|
|
||||||
|
{{ $dateMachine := .Date | time.Format "2006-01-02T15:04:05-07:00" }}
|
||||||
|
{{ $dateHuman := .Date | time.Format ":date_long" }}
|
||||||
|
<time datetime="{{ $dateMachine }}">{{ $dateHuman }}</time>
|
||||||
|
|
||||||
|
{{ .Content }}
|
||||||
|
{{ partial "terms.html" (dict "taxonomy" "tags" "page" .) }}
|
||||||
|
{{ end }}
|
1
create/skeletons/theme/layouts/partials/footer.html
Normal file
1
create/skeletons/theme/layouts/partials/footer.html
Normal file
|
@ -0,0 +1 @@
|
||||||
|
<p>Copyright {{ now.Year }}. All rights reserved.</p>
|
5
create/skeletons/theme/layouts/partials/head.html
Normal file
5
create/skeletons/theme/layouts/partials/head.html
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta name="viewport" content="width=device-width, minimum-scale=1.0, initial-scale=1.0">
|
||||||
|
<title>{{ if .IsHome }}{{ site.Title }}{{ else }}{{ printf "%s | %s" .Title site.Title }}{{ end }}</title>
|
||||||
|
{{ partialCached "head/css.html" . }}
|
||||||
|
{{ partialCached "head/js.html" . }}
|
9
create/skeletons/theme/layouts/partials/head/css.html
Normal file
9
create/skeletons/theme/layouts/partials/head/css.html
Normal file
|
@ -0,0 +1,9 @@
|
||||||
|
{{- with resources.Get "css/main.css" }}
|
||||||
|
{{- if eq hugo.Environment "development" }}
|
||||||
|
<link rel="stylesheet" href="{{ .RelPermalink }}">
|
||||||
|
{{- else }}
|
||||||
|
{{- with . | minify | fingerprint }}
|
||||||
|
<link rel="stylesheet" href="{{ .RelPermalink }}" integrity="{{ .Data.Integrity }}" crossorigin="anonymous">
|
||||||
|
{{- end }}
|
||||||
|
{{- end }}
|
||||||
|
{{- end }}
|
12
create/skeletons/theme/layouts/partials/head/js.html
Normal file
12
create/skeletons/theme/layouts/partials/head/js.html
Normal file
|
@ -0,0 +1,12 @@
|
||||||
|
{{- with resources.Get "js/main.js" }}
|
||||||
|
{{- if eq hugo.Environment "development" }}
|
||||||
|
{{- with . | js.Build }}
|
||||||
|
<script src="{{ .RelPermalink }}"></script>
|
||||||
|
{{- end }}
|
||||||
|
{{- else }}
|
||||||
|
{{- $opts := dict "minify" true }}
|
||||||
|
{{- with . | js.Build $opts | fingerprint }}
|
||||||
|
<script src="{{ .RelPermalink }}" integrity="{{- .Data.Integrity }}" crossorigin="anonymous"></script>
|
||||||
|
{{- end }}
|
||||||
|
{{- end }}
|
||||||
|
{{- end }}
|
2
create/skeletons/theme/layouts/partials/header.html
Normal file
2
create/skeletons/theme/layouts/partials/header.html
Normal file
|
@ -0,0 +1,2 @@
|
||||||
|
<h1>{{ site.Title }}</h1>
|
||||||
|
{{ partial "menu.html" (dict "menuID" "main" "page" .) }}
|
45
create/skeletons/theme/layouts/partials/menu.html
Normal file
45
create/skeletons/theme/layouts/partials/menu.html
Normal file
|
@ -0,0 +1,45 @@
|
||||||
|
{{- /*
|
||||||
|
Renders a menu for the given menu ID.
|
||||||
|
|
||||||
|
@context {page} page The current page.
|
||||||
|
@context {string} menuID The menu ID.
|
||||||
|
|
||||||
|
@example: {{ partial "menu.html" (dict "menuID" "main" "page" .) }}
|
||||||
|
*/}}
|
||||||
|
|
||||||
|
{{- $page := .page }}
|
||||||
|
{{- $menuID := .menuID }}
|
||||||
|
|
||||||
|
{{- with index site.Menus $menuID }}
|
||||||
|
<nav>
|
||||||
|
<ul>
|
||||||
|
{{- partial "inline/menu/walk.html" (dict "page" $page "menuEntries" .) }}
|
||||||
|
</ul>
|
||||||
|
</nav>
|
||||||
|
{{- end }}
|
||||||
|
|
||||||
|
{{- define "partials/inline/menu/walk.html" }}
|
||||||
|
{{- $page := .page }}
|
||||||
|
{{- range .menuEntries }}
|
||||||
|
{{- $attrs := dict "href" .URL }}
|
||||||
|
{{- if $page.IsMenuCurrent .Menu . }}
|
||||||
|
{{- $attrs = merge $attrs (dict "class" "active" "aria-current" "page") }}
|
||||||
|
{{- else if $page.HasMenuCurrent .Menu .}}
|
||||||
|
{{- $attrs = merge $attrs (dict "class" "ancestor" "aria-current" "true") }}
|
||||||
|
{{- end }}
|
||||||
|
<li>
|
||||||
|
<a
|
||||||
|
{{- range $k, $v := $attrs }}
|
||||||
|
{{- with $v }}
|
||||||
|
{{- printf " %s=%q" $k $v | safeHTMLAttr }}
|
||||||
|
{{- end }}
|
||||||
|
{{- end -}}
|
||||||
|
>{{ or (T .Identifier) .Name | safeHTML }}</a>
|
||||||
|
{{- with .Children }}
|
||||||
|
<ul>
|
||||||
|
{{- partial "inline/menu/walk.html" (dict "page" $page "menuEntries" .) }}
|
||||||
|
</ul>
|
||||||
|
{{- end }}
|
||||||
|
</li>
|
||||||
|
{{- end }}
|
||||||
|
{{- end }}
|
23
create/skeletons/theme/layouts/partials/terms.html
Normal file
23
create/skeletons/theme/layouts/partials/terms.html
Normal file
|
@ -0,0 +1,23 @@
|
||||||
|
{{- /*
|
||||||
|
For a given taxonomy, renders a list of terms assigned to the page.
|
||||||
|
|
||||||
|
@context {page} page The current page.
|
||||||
|
@context {string} taxonomy The taxonony.
|
||||||
|
|
||||||
|
@example: {{ partial "terms.html" (dict "taxonomy" "tags" "page" .) }}
|
||||||
|
*/}}
|
||||||
|
|
||||||
|
{{- $page := .page }}
|
||||||
|
{{- $taxonomy := .taxonomy }}
|
||||||
|
|
||||||
|
{{- with $page.GetTerms $taxonomy }}
|
||||||
|
{{- $label := (index . 0).Parent.LinkTitle }}
|
||||||
|
<div>
|
||||||
|
<div>{{ $label }}:</div>
|
||||||
|
<ul>
|
||||||
|
{{- range . }}
|
||||||
|
<li><a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a></li>
|
||||||
|
{{- end }}
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
{{- end }}
|
BIN
create/skeletons/theme/static/favicon.ico
Normal file
BIN
create/skeletons/theme/static/favicon.ico
Normal file
Binary file not shown.
After Width: | Height: | Size: 15 KiB |
31
create/skeletons/theme/theme.toml
Normal file
31
create/skeletons/theme/theme.toml
Normal file
|
@ -0,0 +1,31 @@
|
||||||
|
name = 'Theme name'
|
||||||
|
license = 'MIT'
|
||||||
|
licenselink = 'https://github.com/owner/repo/LICENSE'
|
||||||
|
description = 'Theme description'
|
||||||
|
|
||||||
|
# The home page of the theme, where the source can be found
|
||||||
|
homepage = 'https://github.com/owner/repo'
|
||||||
|
|
||||||
|
# If you have a running demo of the theme
|
||||||
|
demosite = 'https://owner.github.io/repo'
|
||||||
|
|
||||||
|
# Taxonomy terms
|
||||||
|
tags = ['blog', 'company']
|
||||||
|
features = ['some', 'awesome', 'features']
|
||||||
|
|
||||||
|
# If the theme has multiple authors
|
||||||
|
authors = [
|
||||||
|
{name = 'Name of author', homepage = 'Website of author'},
|
||||||
|
{name = 'Name of author', homepage = 'Website of author'}
|
||||||
|
]
|
||||||
|
|
||||||
|
# If the theme has a single author
|
||||||
|
[author]
|
||||||
|
name = 'Your name'
|
||||||
|
homepage = 'Your website'
|
||||||
|
|
||||||
|
# If porting an existing theme
|
||||||
|
[original]
|
||||||
|
author = 'Name of original author'
|
||||||
|
homepage = 'Website of original author'
|
||||||
|
repo = 'https://github.com/owner/repo'
|
|
@ -5,20 +5,52 @@ stdout 'Create a new site in the provided directory'
|
||||||
hugo new site my-yaml-site --format yml
|
hugo new site my-yaml-site --format yml
|
||||||
checkfile my-yaml-site/hugo.yml
|
checkfile my-yaml-site/hugo.yml
|
||||||
hugo new site mysite -f
|
hugo new site mysite -f
|
||||||
stdout 'Congratulations! Your new Hugo site is created in'
|
stdout 'Congratulations! Your new Hugo site was created in'
|
||||||
cd mysite
|
cd mysite
|
||||||
|
checkfile archetypes/default.md
|
||||||
checkfile hugo.toml
|
checkfile hugo.toml
|
||||||
|
exists assets
|
||||||
|
exists content
|
||||||
|
exists data
|
||||||
|
exists i18n
|
||||||
|
exists layouts
|
||||||
|
exists static
|
||||||
|
exists themes
|
||||||
|
|
||||||
hugo new theme -h
|
hugo new theme -h
|
||||||
stdout 'Create a new theme \(skeleton\) called \[name\] in ./themes'
|
stdout 'Create a new theme \(skeleton\) called \[name\] in ./themes'
|
||||||
hugo new theme mytheme
|
hugo new theme mytheme
|
||||||
stdout 'Creating theme'
|
stdout 'Creating new theme'
|
||||||
cd themes
|
cd themes
|
||||||
cd mytheme
|
cd mytheme
|
||||||
|
checkfile archetypes/default.md
|
||||||
|
checkfile assets/css/main.css
|
||||||
|
checkfile assets/js/main.js
|
||||||
|
checkfile config/_default/hugo.toml
|
||||||
|
checkfile config/_default/menus.toml
|
||||||
|
checkfile content/_index.md
|
||||||
|
checkfile content/posts/_index.md
|
||||||
|
checkfile content/posts/post-1.md
|
||||||
|
checkfile content/posts/post-2.md
|
||||||
|
checkfile content/posts/post-3/bryce-canyon.jpg
|
||||||
|
checkfile content/posts/post-3/index.md
|
||||||
|
checkfile layouts/_default/baseof.html
|
||||||
|
checkfile layouts/_default/home.html
|
||||||
|
checkfile layouts/_default/list.html
|
||||||
|
checkfile layouts/_default/single.html
|
||||||
|
checkfile layouts/partials/footer.html
|
||||||
|
checkfile layouts/partials/head.html
|
||||||
|
checkfile layouts/partials/head/css.html
|
||||||
|
checkfile layouts/partials/head/js.html
|
||||||
|
checkfile layouts/partials/header.html
|
||||||
|
checkfile layouts/partials/menu.html
|
||||||
|
checkfile layouts/partials/terms.html
|
||||||
|
checkfile static/favicon.ico
|
||||||
|
checkfile LICENSE
|
||||||
|
checkfile README.md
|
||||||
checkfile theme.toml
|
checkfile theme.toml
|
||||||
checkfile hugo.toml
|
exists data
|
||||||
exists layouts/_default/list.html
|
exists i18n
|
||||||
exists layouts/_default/single.html
|
|
||||||
|
|
||||||
cd $WORK/mysite
|
cd $WORK/mysite
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue