su-hugo

command module

v1.0.0 Latest Latest Go to latest Published: Dec 20, 2022 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/SuCicada/su-hugo

README ¶

A Fast and Flexible Static Site Generator built with love by bep, spf13 and friends in Go.

Overview
Banner Sponsors
Supported Architectures
Choose How to Install
- Install Hugo as Your Site Generator (Binary Install)
- Build and Install the Binary from Source (Using the Go toolchain)
The Hugo Documentation
Contributing to Hugo
Dependencies

Overview

Hugo is a static HTML and CSS website generator written in Go. It is optimized for speed, ease of use, and configurability. Hugo takes a directory with content and templates and renders them into a full HTML website.

Hugo relies on Markdown files with front matter for metadata, and you can run Hugo from any directory. This works well for shared hosts and other systems where you don’t have a privileged account.

Hugo renders a typical website of moderate size in a fraction of a second. A good rule of thumb is that each piece of content renders in around 1 millisecond.

Hugo is designed to work well for any kind of website including blogs, tumbles, and docs.

Supported Architectures

Currently, we provide pre-built Hugo binaries for Windows, Linux, FreeBSD, NetBSD, DragonFly BSD, OpenBSD, macOS (Darwin), and Android for x64, i386 and ARM architectures.

Hugo may also be compiled from source wherever the Go compiler tool chain can run, e.g. for other operating systems including Plan 9 and Solaris.

Complete documentation is available at Hugo Documentation.

Choose How to Install

If you want to use Hugo as your site generator, simply install the Hugo binaries.

To contribute to the Hugo source code or documentation, you should fork the Hugo GitHub project and clone it to your local machine.

Finally, you can install the Hugo source code with go, build the binaries yourself, and run Hugo that way. Building the binaries is an easy task for an experienced go getter.

Install Hugo as Your Site Generator (Binary Install)

Use the installation instructions in the Hugo documentation.

Build and Install the Binary from Source (Using the Go toolchain)

Prerequisite Tools

Go (we test it with the last 2 major versions; but note that Hugo 0.95.0 only builds with >= Go 1.18.)

Fetch from GitHub

To fetch, build and install from the Github source:

go install github.com/gohugoio/hugo@latest

If you want to compile with Sass/SCSS support use --tags extended and make sure CGO_ENABLED=1 is set in your go environment. If you don't want to have CGO enabled, you may use the following command to temporarily enable CGO only for hugo compilation:

CGO_ENABLED=1 go install --tags extended github.com/gohugoio/hugo@latest

The Hugo Documentation

The Hugo documentation now lives in its own repository, see https://github.com/gohugoio/hugoDocs. But we do keep a version of that documentation as a git subtree in this repository. To build the sub folder /docs as a Hugo site, you need to clone this repo:

git clone git@github.com:gohugoio/hugo.git

Contributing code to Hugo

Note March 16th 2022: We are currently very constrained on human resources to do code reviews, so we currently require any new Pull Requests to be limited to bug fixes closing an existing issue. Also, we have updated to Go 1.18, but we will currently not accept any generic rewrites, "interface{} to any" replacements and similar.

For a complete guide to contributing to Hugo, see the Contribution Guide.

We welcome contributions to Hugo of any kind including documentation, themes, organization, tutorials, blog posts, bug reports, issues, feature requests, feature implementations, pull requests, answering questions on the forum, helping to manage issues, etc.

The Hugo community and maintainers are very active and helpful, and the project benefits greatly from this activity.

Asking Support Questions

We have an active discussion forum where users and developers can ask questions. Please don't use the GitHub issue tracker to ask questions.

Reporting Issues

If you believe you have found a defect in Hugo or its documentation, use the GitHub issue tracker to report the problem to the Hugo maintainers. If you're not sure if it's a bug or not, start by asking in the discussion forum. When reporting the issue, please provide the version of Hugo in use (hugo version).

Dependencies

Hugo stands on the shoulder of many great open source libraries.

If you run hugo env -v you will get a complete and up to date list.

In Hugo 0.100.1 that list is, in lexical order:

cloud.google.com/go/compute="v1.6.1"
cloud.google.com/go/iam="v0.3.0"
cloud.google.com/go/storage="v1.22.0"
cloud.google.com/go="v0.101.0"
github.com/Azure/azure-pipeline-go="v0.2.3"
github.com/Azure/azure-storage-blob-go="v0.14.0"
github.com/Azure/go-autorest/autorest/adal="v0.9.15"
github.com/Azure/go-autorest/autorest/date="v0.3.0"
github.com/Azure/go-autorest/autorest="v0.11.20"
github.com/Azure/go-autorest/logger="v0.2.1"
github.com/Azure/go-autorest/tracing="v0.6.0"
github.com/BurntSushi/locker="v0.0.0-20171006230638-a6e239ea1c69"
github.com/PuerkitoBio/purell="v1.1.1"
github.com/PuerkitoBio/urlesc="v0.0.0-20170810143723-de5bf2ad4578"
github.com/alecthomas/chroma="v0.10.0"
github.com/armon/go-radix="v1.0.0"
github.com/aws/aws-sdk-go-v2/config="v1.7.0"
github.com/aws/aws-sdk-go-v2/credentials="v1.4.0"
github.com/aws/aws-sdk-go-v2/feature/ec2/imds="v1.5.0"
github.com/aws/aws-sdk-go-v2/internal/ini="v1.2.2"
github.com/aws/aws-sdk-go-v2/service/internal/presigned-url="v1.3.0"
github.com/aws/aws-sdk-go-v2/service/sso="v1.4.0"
github.com/aws/aws-sdk-go-v2/service/sts="v1.7.0"
github.com/aws/aws-sdk-go-v2="v1.9.0"
github.com/aws/aws-sdk-go="v1.43.5"
github.com/aws/smithy-go="v1.8.0"
github.com/bep/clock="v0.3.0"
github.com/bep/debounce="v1.2.0"
github.com/bep/gitmap="v1.1.2"
github.com/bep/goat="v0.5.0"
github.com/bep/godartsass="v0.14.0"
github.com/bep/golibsass="v1.1.0"
github.com/bep/gowebp="v0.1.0"
github.com/bep/overlayfs="v0.6.0"
github.com/bep/tmc="v0.5.1"
github.com/clbanning/mxj/v2="v2.5.5"
github.com/cli/safeexec="v1.0.0"
github.com/cpuguy83/go-md2man/v2="v2.0.1"
github.com/disintegration/gift="v1.2.1"
github.com/dlclark/regexp2="v1.4.0"
github.com/dustin/go-humanize="v1.0.0"
github.com/evanw/esbuild="v0.14.42"
github.com/frankban/quicktest="v1.14.3"
github.com/fsnotify/fsnotify="v1.5.4"
github.com/getkin/kin-openapi="v0.94.0"
github.com/ghodss/yaml="v1.0.0"
github.com/go-openapi/jsonpointer="v0.19.5"
github.com/go-openapi/swag="v0.19.5"
github.com/gobuffalo/flect="v0.2.5"
github.com/gobwas/glob="v0.2.3"
github.com/gohugoio/go-i18n/v2="v2.1.3-0.20210430103248-4c28c89f8013"
github.com/gohugoio/locales="v0.14.0"
github.com/gohugoio/localescompressed="v1.0.1"
github.com/golang-jwt/jwt/v4="v4.0.0"
github.com/golang/groupcache="v0.0.0-20210331224755-41bb18bfe9da"
github.com/golang/protobuf="v1.5.2"
github.com/google/go-cmp="v0.5.8"
github.com/google/uuid="v1.3.0"
github.com/google/wire="v0.5.0"
github.com/googleapis/gax-go/v2="v2.3.0"
github.com/googleapis/go-type-adapters="v1.0.0"
github.com/gorilla/websocket="v1.5.0"
github.com/hairyhenderson/go-codeowners="v0.2.3-0.20201026200250-cdc7c0759690"
github.com/inconshreveable/mousetrap="v1.0.0"
github.com/jdkato/prose="v1.2.1"
github.com/jmespath/go-jmespath="v0.4.0"
github.com/kr/pretty="v0.3.0"
github.com/kr/text="v0.2.0"
github.com/kyokomi/emoji/v2="v2.2.9"
github.com/mailru/easyjson="v0.0.0-20190626092158-b2ccc519800e"
github.com/mattn/go-ieproxy="v0.0.1"
github.com/mattn/go-isatty="v0.0.14"
github.com/mattn/go-runewidth="v0.0.9"
github.com/mitchellh/hashstructure="v1.1.0"
github.com/mitchellh/mapstructure="v1.5.0"
github.com/muesli/smartcrop="v0.3.0"
github.com/niklasfasching/go-org="v1.6.2"
github.com/olekukonko/tablewriter="v0.0.5"
github.com/pelletier/go-toml/v2="v2.0.0-beta.7.0.20220408132554-2377ac4bc04c"
github.com/rogpeppe/go-internal="v1.8.1"
github.com/russross/blackfriday/v2="v2.1.0"
github.com/rwcarlsen/goexif="v0.0.0-20190401172101-9e8deecbddbd"
github.com/sanity-io/litter="v1.5.5"
github.com/sass/libsass="3.6.5"
github.com/spf13/afero="v1.8.2"
github.com/spf13/cast="v1.5.0"
github.com/spf13/cobra="v1.4.0"
github.com/spf13/fsync="v0.9.0"
github.com/spf13/jwalterweatherman="v1.1.0"
github.com/spf13/pflag="v1.0.5"
github.com/tdewolff/minify/v2="v2.11.5"
github.com/tdewolff/parse/v2="v2.5.31"
github.com/webmproject/libwebp="v1.2.0"
github.com/yuin/goldmark="v1.4.12"
go.opencensus.io="v0.23.0"
go.uber.org/atomic="v1.9.0"
gocloud.dev="v0.24.0"
golang.org/x/crypto="v0.0.0-20211108221036-ceb1ce70b4fa"
golang.org/x/image="v0.0.0-20211028202545-6944b10bf410"
golang.org/x/net="v0.0.0-20220425223048-2871e0cb64e4"
golang.org/x/oauth2="v0.0.0-20220411215720-9780585627b5"
golang.org/x/sync="v0.0.0-20210220032951-036812b2e83c"
golang.org/x/sys="v0.0.0-20220422013727-9388b58f7150"
golang.org/x/text="v0.3.7"
golang.org/x/tools="v0.1.10"
golang.org/x/xerrors="v0.0.0-20220411194840-2f41105eb62f"
google.golang.org/api="v0.76.0"
google.golang.org/genproto="v0.0.0-20220426171045-31bebdecfb46"
google.golang.org/grpc="v1.46.0"
google.golang.org/protobuf="v1.28.0"
gopkg.in/yaml.v2="v2.4.0"

Documentation ¶

There is no documentation for this package.

Source Files ¶

View all Source files

main.go

Directories ¶

Path	Synopsis
bufferpool Package bufferpool provides a pool of bytes buffers.	Package bufferpool provides a pool of bytes buffers.
cache
filecache
namedmemcache Package namedmemcache provides a memory cache with a named lock.	Package namedmemcache provides a memory cache with a named lock.
codegen Package codegen contains helpers for code generation.	Package codegen contains helpers for code generation.
commands Package commands defines and implements command-line commands and flags used by Hugo.	Package commands defines and implements command-line commands and flags used by Hugo.
common
collections Package collections contains common Hugo functionality related to collection handling.	Package collections contains common Hugo functionality related to collection handling.
constants
herrors Package herrors contains common Hugo errors and error related utilities.	Package herrors contains common Hugo errors and error related utilities.
hexec
hreflect Package hreflect contains reflect helpers.	Package hreflect contains reflect helpers.
htime
hugio
hugo
loggers
maps
math
para Package para implements parallel execution helpers.	Package para implements parallel execution helpers.
paths
terminal Package terminal contains helper for the terminal, such as coloring output.	Package terminal contains helper for the terminal, such as coloring output.
text
types Package types contains types shared between packages in Hugo.	Package types contains types shared between packages in Hugo.
types/hstring
urls
compare
config
privacy
security
services
create Package create provides functions to create new content.	Package create provides functions to create new content.
deploy
deps
docshelper Package docshelper provides some helpers for the Hugo documentation, and is of limited interest for the general Hugo user.	Package docshelper provides some helpers for the Hugo documentation, and is of limited interest for the general Hugo user.
helpers Package helpers implements general utility functions that work with and on content.	Package helpers implements general utility functions that work with and on content.
htesting
hqt
hugofs Package hugofs provides the file systems used by Hugo.	Package hugofs provides the file systems used by Hugo.
files
glob
hugolib
filesystems Package filesystems provides the fine grained file systems used by Hugo.	Package filesystems provides the fine grained file systems used by Hugo.
paths
identity
langs
i18n
lazy
livereload
markup
asciidocext Package asciidocext converts AsciiDoc to HTML using Asciidoctor external binary.	Package asciidocext converts AsciiDoc to HTML using Asciidoctor external binary.
asciidocext/asciidocext_config Package asciidoc_config holds asciidoc related configuration.	Package asciidoc_config holds asciidoc related configuration.
blackfriday Package blackfriday holds some copmpability functions for the old Blackfriday v1 Markdown engine.	Package blackfriday holds some copmpability functions for the old Blackfriday v1 Markdown engine.
converter
converter/hooks
goldmark Package goldmark converts Markdown to HTML using Goldmark.	Package goldmark converts Markdown to HTML using Goldmark.
goldmark/codeblocks
goldmark/goldmark_config Package goldmark_config holds Goldmark related configuration.	Package goldmark_config holds Goldmark related configuration.
goldmark/images
goldmark/internal/extensions/attributes
goldmark/internal/render
goldmark/links
highlight Package highlight provides code highlighting.	Package highlight provides code highlighting.
highlight/chromalexers
internal
internal/attributes
markup_config
org Package org converts Emacs Org-Mode to HTML.	Package org converts Emacs Org-Mode to HTML.
pandoc Package pandoc converts content to HTML using Pandoc as an external helper.	Package pandoc converts content to HTML using Pandoc as an external helper.
rst Package rst converts content to HTML using the RST external helper.	Package rst converts content to HTML using the RST external helper.
tableofcontents
media
metrics Package metrics provides simple metrics tracking features.	Package metrics provides simple metrics tracking features.
minifiers Package minifiers contains minifiers mapped to MIME types.	Package minifiers contains minifiers mapped to MIME types.
modules Package modules provides a client that can be used to manage Hugo Components, what's referred to as Hugo Modules.	Package modules provides a client that can be used to manage Hugo Components, what's referred to as Hugo Modules.
npm
navigation
output
parser
metadecoders
pageparser Package pageparser provides a parser for Hugo content files (Markdown, HTML etc.) in Hugo.	Package pageparser provides a parser for Hugo content files (Markdown, HTML etc.) in Hugo.
publisher
related Package related holds code to help finding related content.	Package related holds code to help finding related content.
releaser Package releaser implements a set of utilities and a wrapper around Goreleaser to help automate the Hugo release process.	Package releaser implements a set of utilities and a wrapper around Goreleaser to help automate the Hugo release process.
resources
images Package images provides template functions for manipulating images.	Package images provides template functions for manipulating images.
images/exif
images/webp
internal
jsconfig
page Package page contains the core interfaces and types for the Page resource, a core component in Hugo.	Package page contains the core interfaces and types for the Page resource, a core component in Hugo.
page/page_generate
page/pagemeta
postpub
resource
resource_factories/bundler Package bundler contains functions for concatenation etc.	Package bundler contains functions for concatenation etc.
resource_factories/create Package create contains functions for to create Resource objects.	Package create contains functions for to create Resource objects.
resource_transformers/babel
resource_transformers/htesting
resource_transformers/integrity
resource_transformers/js
resource_transformers/minifier
resource_transformers/postcss
resource_transformers/templates Package templates contains functions for template processing of Resource objects.	Package templates contains functions for template processing of Resource objects.
resource_transformers/tocss/dartsass Package godartsass integrates with the Dass Sass Embedded protocol to transpile SCSS/SASS.	Package godartsass integrates with the Dass Sass Embedded protocol to transpile SCSS/SASS.
resource_transformers/tocss/scss
scripts
fork_go_templates
source
tpl
cast Package cast provides template functions for data type conversions.	Package cast provides template functions for data type conversions.
collections Package collections provides template functions for manipulating collections such as arrays, maps, and slices.	Package collections provides template functions for manipulating collections such as arrays, maps, and slices.
compare Package compare provides template functions for comparing values.	Package compare provides template functions for comparing values.
crypto Package crypto provides template functions for cryptographic operations.	Package crypto provides template functions for cryptographic operations.
data Package data provides template functions for working with external data sources.	Package data provides template functions for working with external data sources.
debug Package debug provides template functions to help debugging templates.	Package debug provides template functions to help debugging templates.
diagrams
encoding Package encoding provides template functions for encoding content.	Package encoding provides template functions for encoding content.
fmt Package fmt provides template functions for formatting strings.	Package fmt provides template functions for formatting strings.
hugo Package hugo provides template functions for accessing the Site Hugo object.	Package hugo provides template functions for accessing the Site Hugo object.
images Package images provides template functions for manipulating images.	Package images provides template functions for manipulating images.
inflect Package inflect provides template functions for the inflection of words.	Package inflect provides template functions for the inflection of words.
internal
internal/go_templates/cfg Package cfg holds configuration shared by the Go command and internal/testenv.	Package cfg holds configuration shared by the Go command and internal/testenv.
internal/go_templates/fmtsort Package fmtsort provides a general stable ordering mechanism for maps, on behalf of the fmt and text/template packages.	Package fmtsort provides a general stable ordering mechanism for maps, on behalf of the fmt and text/template packages.
internal/go_templates/htmltemplate Package template (html/template) implements data-driven templates for generating HTML output safe against code injection.	Package template (html/template) implements data-driven templates for generating HTML output safe against code injection.
internal/go_templates/testenv Package testenv provides information about what functionality is available in different testing environments run by the Go team.	Package testenv provides information about what functionality is available in different testing environments run by the Go team.
internal/go_templates/texttemplate Package template implements data-driven templates for generating textual output.	Package template implements data-driven templates for generating textual output.
internal/go_templates/texttemplate/parse Package parse builds parse trees for templates as defined by text/template and html/template.	Package parse builds parse trees for templates as defined by text/template and html/template.
internal/resourcehelpers
js Package js provides functions for building JavaScript resources	Package js provides functions for building JavaScript resources
lang Package lang provides template functions for content internationalization.	Package lang provides template functions for content internationalization.
math Package math provides template functions for mathematical operations.	Package math provides template functions for mathematical operations.
openapi/openapi3
os Package os provides template functions for interacting with the operating system.	Package os provides template functions for interacting with the operating system.
partials Package partials provides template functions for working with reusable templates.	Package partials provides template functions for working with reusable templates.
path Package path provides template functions for manipulating paths.	Package path provides template functions for manipulating paths.
reflect Package reflect provides template functions for run-time object reflection.	Package reflect provides template functions for run-time object reflection.
resources Package resources provides template functions for working with resources.	Package resources provides template functions for working with resources.
safe Package safe provides template functions for escaping untrusted content or encapsulating trusted content.	Package safe provides template functions for escaping untrusted content or encapsulating trusted content.
site Package site provides template functions for accessing the Site object.	Package site provides template functions for accessing the Site object.
strings Package strings provides template functions for manipulating strings.	Package strings provides template functions for manipulating strings.
templates Package templates provides template functions for working with templates.	Package templates provides template functions for working with templates.
time Package time provides template functions for measuring and displaying time.	Package time provides template functions for measuring and displaying time.
tplimpl
transform Package transform provides template functions for transforming content.	Package transform provides template functions for transforming content.
urls Package urls provides template functions to deal with URLs.	Package urls provides template functions to deal with URLs.
transform
livereloadinject
metainject
urlreplacers
watcher
filenotify Package filenotify provides a mechanism for watching file(s) for changes.	Package filenotify provides a mechanism for watching file(s) for changes.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL