From: Bjørn Erik Pedersen Date: Thu, 6 Jul 2017 08:25:46 +0000 (+0200) Subject: docs: Merge docs commit '37c69054e294bf554be03cf7e4c01e1f586e6943' X-Git-Tag: v0.25~10 X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=e00f5c9c0;p=brevno-suite%2Fhugo docs: Merge docs commit '37c69054e294bf554be03cf7e4c01e1f586e6943' --- e00f5c9c0724001c6a550029587683aa30e8d626 diff --cc docs/README.md index 9e89a038,00000000..60a554e5 mode 100644,000000..100644 --- a/docs/README.md +++ b/docs/README.md @@@ -1,3 -1,0 +1,13 @@@ +# Hugo Docs + +Documentation site for [Hugo](https://github.com/gohugoio/hugo), the very fast and flexible static site generator built with love in GoLang. ++ ++## Branches ++ ++* The `master` branch is the **current Hugo version** and will be auto-deployed to [gohugo.io/](https://gohugo.io/). ++* Anything not relevant to the current Hugo version goes into the `dev` branch. ++* Changes in [hugo/docs](https://github.com/gohugoio/hugo/tree/master/docs) will, in general, be merged once every release, but can be manually merged/cherry picked if needed. This goes both ways. ++* All contributions that is not tightly coupled with code changes, should be made directly to `hugoDocs`. ++* But we also merge PRs into [hugo/docs](https://github.com/gohugoio/hugo/tree/master/docs), but preferably changes that is related to the code in the PR itself ++ ++To summarize, we have two branches in this repository: `master` (current Hugo) and `dev` (next Hugo). diff --cc docs/config.toml index 31f5e009,00000000..a3673418 mode 100644,000000..100644 --- a/docs/config.toml +++ b/docs/config.toml @@@ -1,135 -1,0 +1,135 @@@ +title = "Hugo: A Fast and Flexible Website Generator" +baseurl = "http://gohugo.io/" +MetaDataFormat = "yaml" +pluralizeListTitles = false +# We do redirects via Netlify's _redirects file, generated by Hugo (see "outputs" below). +disableAliases = true + +[blackfriday] + plainIDAnchors = true + +[outputs] +home = [ "HTML", "RSS", "REDIR" ] + +[mediaTypes] +[mediaTypes."text/netlify"] +suffix = "" +delimiter = "" + +[outputFormats] +[outputFormats.REDIR] +mediatype = "text/netlify" +baseName = "_redirects" +isPlainText = true +notAlternative = true + +[params] + description = "Documentation of Hugo, a fast and flexible static site generator built with love by spf13, bep and friends in Go" + author = "Steve Francia (spf13) and friends" - release = "0.25-DEV" ++ release = "0.24.1" + +[taxonomies] + tag = "tags" + group = "groups" + +[[menu.main]] + name = "Download Hugo" + pre = "" + url = "https://github.com/gohugoio/hugo/releases" + weight = -200 +[[menu.main]] + name = "Site Showcase" + pre = "" + url = "/showcase/" + weight = -180 +[[menu.main]] + name = "Theme Showcase" + pre = "" + url = "http://themes.gohugo.io" + weight = -170 +[[menu.main]] + name = "Press & Articles" + pre = "" + url = "/community/press/" + weight = -160 +[[menu.main]] + name = "Discuss Hugo" + pre = "" + url = "https://discourse.gohugo.io/" + weight = -150 +[[menu.main]] + name = "About Hugo" + identifier = "about" + pre = "" + weight = -110 +[[menu.main]] + name = "Release Notes" + url = "/release-notes/" + pre = "" + weight = -111 +[[menu.main]] + name = "Getting Started" + identifier = "getting started" + pre = "" + weight = -100 +[[menu.main]] + name = "Content" + identifier = "content" + pre = "" + weight = -90 +[[menu.main]] + name = "Themes" + identifier = "themes" + pre = "" + weight = -85 +[[menu.main]] + parent = "themes" + name = "Theme Showcase" + url = "http://themes.gohugo.io" + weight = -170 +[[menu.main]] + name = "Templates" + identifier = "layout" + pre = "" + weight = -80 +[[menu.main]] + name = "Taxonomies" + identifier = "taxonomy" + pre = "" + weight = -70 +[[menu.main]] + name = "Extras" + identifier = "extras" + pre = "" + weight = -60 +[[menu.main]] + name = "Community" + identifier = "community" + pre = "" + weight = -50 +[[menu.main]] + parent = "community" + name = "Discussion Forum" + url = "https://discourse.gohugo.io/" + weight = 150 +[[menu.main]] + name = "Tutorials" + identifier = "tutorials" + pre = "" + weight = -40 +[[menu.main]] + name = "Troubleshooting" + identifier = "troubleshooting" + pre = "" + weight = -30 +[[menu.main]] + name = "Tools" + url = "/tools/" + pre = "" + weight = -25 +[[menu.main]] + name = "Hugo Cmd Reference" + identifier = "commands" + pre = "" + weight = -20 + url = "/commands/" diff --cc docs/content/commands/hugo.md index 90862cf2,00000000..0e02a8a9 mode 100644,000000..100644 --- a/docs/content/commands/hugo.md +++ b/docs/content/commands/hugo.md @@@ -1,80 -1,0 +1,80 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo" +slug: hugo +url: /commands/hugo/ +--- +## hugo + +hugo builds your site + +### Synopsis + + +hugo is the main command, used to build your Hugo site. + +Hugo is a Fast and Flexible Static Site Generator +built with love by spf13 and friends in Go. + +Complete documentation is available at http://gohugo.io/. + +``` +hugo [flags] +``` + +### Options + +``` + -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/ + -D, --buildDrafts include content marked as draft + -E, --buildExpired include expired content + -F, --buildFuture include content with publishdate in the future + --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ + --canonifyURLs if true, all relative URLs will be canonicalized using baseURL + --cleanDestinationDir remove files from destination not found in static directories + --config string config file (default is path/config.yaml|json|toml) + -c, --contentDir string filesystem path to content directory + -d, --destination string filesystem path to write files to + --disable404 do not render 404 page + --disableKinds stringSlice disable different kind of pages (home, RSS etc.) + --disableRSS do not build RSS files + --disableSitemap do not build Sitemap file + --enableGitInfo add Git revision, date and author info to the pages + --forceSyncStatic copy all files when static is changed. + -h, --help help for hugo + --i18n-warnings print missing translations + --ignoreCache ignores the cache directory + -l, --layoutDir string filesystem path to layout directory + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --noChmod don't sync permission mode of files + --noTimes don't sync modification time of files + --pluralizeListTitles pluralize titles in lists using inflect (default true) + --preserveTaxonomyNames preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") + --quiet build in quiet mode + --renderToMemory render to memory (only useful for benchmark testing) + -s, --source string filesystem path to read files relative from + --stepAnalysis display memory and timing of different steps of the program + -t, --theme string theme to use (located in /themes/THEMENAME/) + --themesDir string filesystem path to themes directory + --uglyURLs if true, use /filename.html instead of /filename/ + -v, --verbose verbose output + --verboseLog verbose logging + -w, --watch watch filesystem for changes and recreate as needed +``` + +### SEE ALSO +* [hugo benchmark](/commands/hugo_benchmark/) - Benchmark Hugo by building a site a number of times. +* [hugo check](/commands/hugo_check/) - Contains some verification checks +* [hugo config](/commands/hugo_config/) - Print the site configuration +* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats +* [hugo env](/commands/hugo_env/) - Print Hugo version and environment info +* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. +* [hugo import](/commands/hugo_import/) - Import your site from others. +* [hugo list](/commands/hugo_list/) - Listing out various types of content +* [hugo new](/commands/hugo_new/) - Create new content for your site +* [hugo server](/commands/hugo_server/) - A high performance webserver +* [hugo undraft](/commands/hugo_undraft/) - Undraft changes the content's draft status from 'True' to 'False' +* [hugo version](/commands/hugo_version/) - Print the version number of Hugo + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_benchmark.md index 2bfb1c8d,00000000..acef140a mode 100644,000000..100644 --- a/docs/content/commands/hugo_benchmark.md +++ b/docs/content/commands/hugo_benchmark.md @@@ -1,72 -1,0 +1,72 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo benchmark" +slug: hugo_benchmark +url: /commands/hugo_benchmark/ +--- +## hugo benchmark + +Benchmark Hugo by building a site a number of times. + +### Synopsis + + +Hugo can build a site many times over and analyze the running process +creating a benchmark. + +``` +hugo benchmark [flags] +``` + +### Options + +``` + -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/ + -D, --buildDrafts include content marked as draft + -E, --buildExpired include expired content + -F, --buildFuture include content with publishdate in the future + --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ + --canonifyURLs if true, all relative URLs will be canonicalized using baseURL + --cleanDestinationDir remove files from destination not found in static directories + -c, --contentDir string filesystem path to content directory + -n, --count int number of times to build the site (default 13) + --cpuprofile string path/filename for the CPU profile file + -d, --destination string filesystem path to write files to + --disable404 do not render 404 page + --disableKinds stringSlice disable different kind of pages (home, RSS etc.) + --disableRSS do not build RSS files + --disableSitemap do not build Sitemap file + --enableGitInfo add Git revision, date and author info to the pages + --forceSyncStatic copy all files when static is changed. + -h, --help help for benchmark + --i18n-warnings print missing translations + --ignoreCache ignores the cache directory + -l, --layoutDir string filesystem path to layout directory + --memprofile string path/filename for the memory profile file + --noChmod don't sync permission mode of files + --noTimes don't sync modification time of files + --pluralizeListTitles pluralize titles in lists using inflect (default true) + --preserveTaxonomyNames preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") + --renderToMemory render to memory (only useful for benchmark testing) + -s, --source string filesystem path to read files relative from + --stepAnalysis display memory and timing of different steps of the program + -t, --theme string theme to use (located in /themes/THEMENAME/) + --themesDir string filesystem path to themes directory + --uglyURLs if true, use /filename.html instead of /filename/ +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo](/commands/hugo/) - hugo builds your site + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_check.md index ae686559,00000000..1cab62f3 mode 100644,000000..100644 --- a/docs/content/commands/hugo_check.md +++ b/docs/content/commands/hugo_check.md @@@ -1,37 -1,0 +1,37 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo check" +slug: hugo_check +url: /commands/hugo_check/ +--- +## hugo check + +Contains some verification checks + +### Synopsis + + +Contains some verification checks + +### Options + +``` + -h, --help help for check +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo](/commands/hugo/) - hugo builds your site +* [hugo check ulimit](/commands/hugo_check_ulimit/) - Check system ulimit settings + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_check_ulimit.md index 90ef8b03,00000000..33dae348 mode 100644,000000..100644 --- a/docs/content/commands/hugo_check_ulimit.md +++ b/docs/content/commands/hugo_check_ulimit.md @@@ -1,41 -1,0 +1,41 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo check ulimit" +slug: hugo_check_ulimit +url: /commands/hugo_check_ulimit/ +--- +## hugo check ulimit + +Check system ulimit settings + +### Synopsis + + +Hugo will inspect the current ulimit settings on the system. +This is primarily to ensure that Hugo can watch enough files on some OSs + +``` +hugo check ulimit [flags] +``` + +### Options + +``` + -h, --help help for ulimit +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo check](/commands/hugo_check/) - Contains some verification checks + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_config.md index 1504c078,00000000..f15d28f0 mode 100644,000000..100644 --- a/docs/content/commands/hugo_config.md +++ b/docs/content/commands/hugo_config.md @@@ -1,40 -1,0 +1,40 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo config" +slug: hugo_config +url: /commands/hugo_config/ +--- +## hugo config + +Print the site configuration + +### Synopsis + + +Print the site configuration, both default and custom settings. + +``` +hugo config [flags] +``` + +### Options + +``` + -h, --help help for config +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo](/commands/hugo/) - hugo builds your site + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_convert.md index 67b9f870,00000000..62005e6f mode 100644,000000..100644 --- a/docs/content/commands/hugo_convert.md +++ b/docs/content/commands/hugo_convert.md @@@ -1,44 -1,0 +1,44 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo convert" +slug: hugo_convert +url: /commands/hugo_convert/ +--- +## hugo convert + +Convert your content to different formats + +### Synopsis + + +Convert your content (e.g. front matter) to different formats. + +See convert's subcommands toJSON, toTOML and toYAML for more information. + +### Options + +``` + -h, --help help for convert + -o, --output string filesystem path to write files to + -s, --source string filesystem path to read files relative from + --unsafe enable less safe operations, please backup first +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo](/commands/hugo/) - hugo builds your site +* [hugo convert toJSON](/commands/hugo_convert_tojson/) - Convert front matter to JSON +* [hugo convert toTOML](/commands/hugo_convert_totoml/) - Convert front matter to TOML +* [hugo convert toYAML](/commands/hugo_convert_toyaml/) - Convert front matter to YAML + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_convert_toJSON.md index a2da44ec,00000000..f6136ad4 mode 100644,000000..100644 --- a/docs/content/commands/hugo_convert_toJSON.md +++ b/docs/content/commands/hugo_convert_toJSON.md @@@ -1,44 -1,0 +1,44 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo convert toJSON" +slug: hugo_convert_toJSON +url: /commands/hugo_convert_tojson/ +--- +## hugo convert toJSON + +Convert front matter to JSON + +### Synopsis + + +toJSON converts all front matter in the content directory +to use JSON for the front matter. + +``` +hugo convert toJSON [flags] +``` + +### Options + +``` + -h, --help help for toJSON +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + -o, --output string filesystem path to write files to + --quiet build in quiet mode + -s, --source string filesystem path to read files relative from + --unsafe enable less safe operations, please backup first + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_convert_toTOML.md index 8a48f52f,00000000..229004e7 mode 100644,000000..100644 --- a/docs/content/commands/hugo_convert_toTOML.md +++ b/docs/content/commands/hugo_convert_toTOML.md @@@ -1,44 -1,0 +1,44 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo convert toTOML" +slug: hugo_convert_toTOML +url: /commands/hugo_convert_totoml/ +--- +## hugo convert toTOML + +Convert front matter to TOML + +### Synopsis + + +toTOML converts all front matter in the content directory +to use TOML for the front matter. + +``` +hugo convert toTOML [flags] +``` + +### Options + +``` + -h, --help help for toTOML +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + -o, --output string filesystem path to write files to + --quiet build in quiet mode + -s, --source string filesystem path to read files relative from + --unsafe enable less safe operations, please backup first + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_convert_toYAML.md index 5d85825f,00000000..3c0cafe4 mode 100644,000000..100644 --- a/docs/content/commands/hugo_convert_toYAML.md +++ b/docs/content/commands/hugo_convert_toYAML.md @@@ -1,44 -1,0 +1,44 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo convert toYAML" +slug: hugo_convert_toYAML +url: /commands/hugo_convert_toyaml/ +--- +## hugo convert toYAML + +Convert front matter to YAML + +### Synopsis + + +toYAML converts all front matter in the content directory +to use YAML for the front matter. + +``` +hugo convert toYAML [flags] +``` + +### Options + +``` + -h, --help help for toYAML +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + -o, --output string filesystem path to write files to + --quiet build in quiet mode + -s, --source string filesystem path to read files relative from + --unsafe enable less safe operations, please backup first + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_env.md index 7e268546,00000000..857f0370 mode 100644,000000..100644 --- a/docs/content/commands/hugo_env.md +++ b/docs/content/commands/hugo_env.md @@@ -1,40 -1,0 +1,40 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo env" +slug: hugo_env +url: /commands/hugo_env/ +--- +## hugo env + +Print Hugo version and environment info + +### Synopsis + + +Print Hugo version and environment info. This is useful in Hugo bug reports. + +``` +hugo env [flags] +``` + +### Options + +``` + -h, --help help for env +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo](/commands/hugo/) - hugo builds your site + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_gen.md index 7e753c4e,00000000..c2521aeb mode 100644,000000..100644 --- a/docs/content/commands/hugo_gen.md +++ b/docs/content/commands/hugo_gen.md @@@ -1,39 -1,0 +1,39 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo gen" +slug: hugo_gen +url: /commands/hugo_gen/ +--- +## hugo gen + +A collection of several useful generators. + +### Synopsis + + +A collection of several useful generators. + +### Options + +``` + -h, --help help for gen +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo](/commands/hugo/) - hugo builds your site +* [hugo gen autocomplete](/commands/hugo_gen_autocomplete/) - Generate shell autocompletion script for Hugo +* [hugo gen doc](/commands/hugo_gen_doc/) - Generate Markdown documentation for the Hugo CLI. +* [hugo gen man](/commands/hugo_gen_man/) - Generate man pages for the Hugo CLI + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_gen_autocomplete.md index 455322de,00000000..df89faab mode 100644,000000..100644 --- a/docs/content/commands/hugo_gen_autocomplete.md +++ b/docs/content/commands/hugo_gen_autocomplete.md @@@ -1,58 -1,0 +1,58 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo gen autocomplete" +slug: hugo_gen_autocomplete +url: /commands/hugo_gen_autocomplete/ +--- +## hugo gen autocomplete + +Generate shell autocompletion script for Hugo + +### Synopsis + + +Generates a shell autocompletion script for Hugo. + +NOTE: The current version supports Bash only. + This should work for *nix systems with Bash installed. + +By default, the file is written directly to /etc/bash_completion.d +for convenience, and the command may need superuser rights, e.g.: + + $ sudo hugo gen autocomplete + +Add `--completionfile=/path/to/file` flag to set alternative +file-path and name. + +Logout and in again to reload the completion scripts, +or just source them in directly: + + $ . /etc/bash_completion + +``` +hugo gen autocomplete [flags] +``` + +### Options + +``` + --completionfile string autocompletion file (default "/etc/bash_completion.d/hugo.sh") + -h, --help help for autocomplete + --type string autocompletion type (currently only bash supported) (default "bash") +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_gen_doc.md index d7b2f719,00000000..48402d12 mode 100644,000000..100644 --- a/docs/content/commands/hugo_gen_doc.md +++ b/docs/content/commands/hugo_gen_doc.md @@@ -1,47 -1,0 +1,47 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo gen doc" +slug: hugo_gen_doc +url: /commands/hugo_gen_doc/ +--- +## hugo gen doc + +Generate Markdown documentation for the Hugo CLI. + +### Synopsis + + +Generate Markdown documentation for the Hugo CLI. + +This command is, mostly, used to create up-to-date documentation +of Hugo's command-line interface for http://gohugo.io/. + +It creates one Markdown file per command with front matter suitable +for rendering in Hugo. + +``` +hugo gen doc [flags] +``` + +### Options + +``` + --dir string the directory to write the doc. (default "/tmp/hugodoc/") + -h, --help help for doc +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_gen_man.md index 14c403d9,00000000..efec000e mode 100644,000000..100644 --- a/docs/content/commands/hugo_gen_man.md +++ b/docs/content/commands/hugo_gen_man.md @@@ -1,43 -1,0 +1,43 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo gen man" +slug: hugo_gen_man +url: /commands/hugo_gen_man/ +--- +## hugo gen man + +Generate man pages for the Hugo CLI + +### Synopsis + + +This command automatically generates up-to-date man pages of Hugo's +command-line interface. By default, it creates the man page files +in the "man" directory under the current directory. + +``` +hugo gen man [flags] +``` + +### Options + +``` + --dir string the directory to write the man pages. (default "man/") + -h, --help help for man +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_import.md index ce58bb3a,00000000..aafe8e4f mode 100644,000000..100644 --- a/docs/content/commands/hugo_import.md +++ b/docs/content/commands/hugo_import.md @@@ -1,39 -1,0 +1,39 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo import" +slug: hugo_import +url: /commands/hugo_import/ +--- +## hugo import + +Import your site from others. + +### Synopsis + + +Import your site from other web site generators like Jekyll. + +Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_path`. + +### Options + +``` + -h, --help help for import +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo](/commands/hugo/) - hugo builds your site +* [hugo import jekyll](/commands/hugo_import_jekyll/) - hugo import from Jekyll + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_import_jekyll.md index 89c4c47c,00000000..f3427d04 mode 100644,000000..100644 --- a/docs/content/commands/hugo_import_jekyll.md +++ b/docs/content/commands/hugo_import_jekyll.md @@@ -1,43 -1,0 +1,43 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo import jekyll" +slug: hugo_import_jekyll +url: /commands/hugo_import_jekyll/ +--- +## hugo import jekyll + +hugo import from Jekyll + +### Synopsis + + +hugo import from Jekyll. + +Import from Jekyll requires two paths, e.g. `hugo import jekyll jekyll_root_path target_path`. + +``` +hugo import jekyll [flags] +``` + +### Options + +``` + --force allow import into non-empty target directory + -h, --help help for jekyll +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo import](/commands/hugo_import/) - Import your site from others. + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_list.md index d9c60959,00000000..818c1520 mode 100644,000000..100644 --- a/docs/content/commands/hugo_list.md +++ b/docs/content/commands/hugo_list.md @@@ -1,42 -1,0 +1,42 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo list" +slug: hugo_list +url: /commands/hugo_list/ +--- +## hugo list + +Listing out various types of content + +### Synopsis + + +Listing out various types of content. + +List requires a subcommand, e.g. `hugo list drafts`. + +### Options + +``` + -h, --help help for list + -s, --source string filesystem path to read files relative from +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo](/commands/hugo/) - hugo builds your site +* [hugo list drafts](/commands/hugo_list_drafts/) - List all drafts +* [hugo list expired](/commands/hugo_list_expired/) - List all posts already expired +* [hugo list future](/commands/hugo_list_future/) - List all posts dated in the future + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_list_drafts.md index d84dd56f,00000000..4ca7319b mode 100644,000000..100644 --- a/docs/content/commands/hugo_list_drafts.md +++ b/docs/content/commands/hugo_list_drafts.md @@@ -1,41 -1,0 +1,41 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo list drafts" +slug: hugo_list_drafts +url: /commands/hugo_list_drafts/ +--- +## hugo list drafts + +List all drafts + +### Synopsis + + +List all of the drafts in your content directory. + +``` +hugo list drafts [flags] +``` + +### Options + +``` + -h, --help help for drafts +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -s, --source string filesystem path to read files relative from + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo list](/commands/hugo_list/) - Listing out various types of content + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_list_expired.md index e4304a40,00000000..fcc48085 mode 100644,000000..100644 --- a/docs/content/commands/hugo_list_expired.md +++ b/docs/content/commands/hugo_list_expired.md @@@ -1,42 -1,0 +1,42 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo list expired" +slug: hugo_list_expired +url: /commands/hugo_list_expired/ +--- +## hugo list expired + +List all posts already expired + +### Synopsis + + +List all of the posts in your content directory which has already +expired. + +``` +hugo list expired [flags] +``` + +### Options + +``` + -h, --help help for expired +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -s, --source string filesystem path to read files relative from + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo list](/commands/hugo_list/) - Listing out various types of content + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_list_future.md index 530b4a68,00000000..46e47253 mode 100644,000000..100644 --- a/docs/content/commands/hugo_list_future.md +++ b/docs/content/commands/hugo_list_future.md @@@ -1,42 -1,0 +1,42 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo list future" +slug: hugo_list_future +url: /commands/hugo_list_future/ +--- +## hugo list future + +List all posts dated in the future + +### Synopsis + + +List all of the posts in your content directory which will be +posted in the future. + +``` +hugo list future [flags] +``` + +### Options + +``` + -h, --help help for future +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -s, --source string filesystem path to read files relative from + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo list](/commands/hugo_list/) - Listing out various types of content + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_new.md index bf230a25,00000000..25eb3d80 mode 100644,000000..100644 --- a/docs/content/commands/hugo_new.md +++ b/docs/content/commands/hugo_new.md @@@ -1,50 -1,0 +1,50 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo new" +slug: hugo_new +url: /commands/hugo_new/ +--- +## hugo new + +Create new content for your site + +### Synopsis + + +Create a new content file and automatically set the date and title. +It will guess which kind of file to create based on the path provided. + +You can also specify the kind with `-k KIND`. + +If archetypes are provided in your theme or site, they will be used. + +``` +hugo new [path] [flags] +``` + +### Options + +``` + --editor string edit new content with this editor, if provided + -h, --help help for new + -k, --kind string content type to create + -s, --source string filesystem path to read files relative from +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo](/commands/hugo/) - hugo builds your site +* [hugo new site](/commands/hugo_new_site/) - Create a new site (skeleton) +* [hugo new theme](/commands/hugo_new_theme/) - Create a new theme + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_new_site.md index 8c097e72,00000000..586d4db1 mode 100644,000000..100644 --- a/docs/content/commands/hugo_new_site.md +++ b/docs/content/commands/hugo_new_site.md @@@ -1,45 -1,0 +1,45 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo new site" +slug: hugo_new_site +url: /commands/hugo_new_site/ +--- +## hugo new site + +Create a new site (skeleton) + +### Synopsis + + +Create a new site in the provided directory. +The new site will have the correct structure, but no content or theme yet. +Use `hugo new [contentPath]` to create new content. + +``` +hugo new site [path] [flags] +``` + +### Options + +``` + --force init inside non-empty directory + -f, --format string config & frontmatter format (default "toml") + -h, --help help for site +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -s, --source string filesystem path to read files relative from + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo new](/commands/hugo_new/) - Create new content for your site + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_new_theme.md index 317de98b,00000000..355978fc mode 100644,000000..100644 --- a/docs/content/commands/hugo_new_theme.md +++ b/docs/content/commands/hugo_new_theme.md @@@ -1,44 -1,0 +1,44 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo new theme" +slug: hugo_new_theme +url: /commands/hugo_new_theme/ +--- +## hugo new theme + +Create a new theme + +### Synopsis + + +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. + +``` +hugo new theme [name] [flags] +``` + +### Options + +``` + -h, --help help for theme +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -s, --source string filesystem path to read files relative from + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo new](/commands/hugo_new/) - Create new content for your site + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_server.md index 4c23c93f,00000000..3171a855 mode 100644,000000..100644 --- a/docs/content/commands/hugo_server.md +++ b/docs/content/commands/hugo_server.md @@@ -1,86 -1,0 +1,86 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo server" +slug: hugo_server +url: /commands/hugo_server/ +--- +## hugo server + +A high performance webserver + +### Synopsis + + +Hugo provides its own webserver which builds and serves the site. +While hugo server is high performance, it is a webserver with limited options. +Many run it in production, but the standard behavior is for people to use it +in development and use a more full featured server such as Nginx or Caddy. + +'hugo server' will avoid writing the rendered and served content to disk, +preferring to store it in memory. + +By default hugo will also watch your files for any changes you make and +automatically rebuild the site. It will then live reload any open browser pages +and push the latest content to them. As most Hugo sites are built in a fraction +of a second, you will be able to save and see your changes nearly instantly. + +``` +hugo server [flags] +``` + +### Options + +``` + --appendPort append port to baseURL (default true) + -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/ + --bind string interface to which the server will bind (default "127.0.0.1") + -D, --buildDrafts include content marked as draft + -E, --buildExpired include expired content + -F, --buildFuture include content with publishdate in the future + --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ + --canonifyURLs if true, all relative URLs will be canonicalized using baseURL + --cleanDestinationDir remove files from destination not found in static directories + -c, --contentDir string filesystem path to content directory + -d, --destination string filesystem path to write files to + --disable404 do not render 404 page + --disableKinds stringSlice disable different kind of pages (home, RSS etc.) + --disableLiveReload watch without enabling live browser reload on rebuild + --disableRSS do not build RSS files + --disableSitemap do not build Sitemap file + --enableGitInfo add Git revision, date and author info to the pages + --forceSyncStatic copy all files when static is changed. + -h, --help help for server + --i18n-warnings print missing translations + --ignoreCache ignores the cache directory + -l, --layoutDir string filesystem path to layout directory + --meminterval string interval to poll memory usage (requires --memstats), valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". (default "100ms") + --memstats string log memory usage to this file + --noChmod don't sync permission mode of files + --noTimes don't sync modification time of files + --pluralizeListTitles pluralize titles in lists using inflect (default true) + -p, --port int port on which the server will listen (default 1313) + --preserveTaxonomyNames preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") + --renderToDisk render to Destination path (default is render to memory & serve from there) + -s, --source string filesystem path to read files relative from + --stepAnalysis display memory and timing of different steps of the program + -t, --theme string theme to use (located in /themes/THEMENAME/) + --themesDir string filesystem path to themes directory + --uglyURLs if true, use /filename.html instead of /filename/ + -w, --watch watch filesystem for changes and recreate as needed (default true) +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo](/commands/hugo/) - hugo builds your site + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_undraft.md index e082d0a1,00000000..5cac7b40 mode 100644,000000..100644 --- a/docs/content/commands/hugo_undraft.md +++ b/docs/content/commands/hugo_undraft.md @@@ -1,42 -1,0 +1,42 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo undraft" +slug: hugo_undraft +url: /commands/hugo_undraft/ +--- +## hugo undraft + +Undraft changes the content's draft status from 'True' to 'False' + +### Synopsis + + +Undraft changes the content's draft status from 'True' to 'False' +and updates the date to the current date and time. +If the content's draft status is 'False', nothing is done. + +``` +hugo undraft path/to/content [flags] +``` + +### Options + +``` + -h, --help help for undraft +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo](/commands/hugo/) - hugo builds your site + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/commands/hugo_version.md index a4bdbce0,00000000..d1ee4a4c mode 100644,000000..100644 --- a/docs/content/commands/hugo_version.md +++ b/docs/content/commands/hugo_version.md @@@ -1,40 -1,0 +1,40 @@@ +--- - date: 2017-06-22T21:51:29+02:00 ++date: 2017-06-29T08:42:09+02:00 +title: "hugo version" +slug: hugo_version +url: /commands/hugo_version/ +--- +## hugo version + +Print the version number of Hugo + +### Synopsis + + +All software has versions. This is Hugo's. + +``` +hugo version [flags] +``` + +### Options + +``` + -h, --help help for version +``` + +### Options inherited from parent commands + +``` + --config string config file (default is path/config.yaml|json|toml) + --log enable Logging + --logFile string log File path (if set, logging enabled automatically) + --quiet build in quiet mode + -v, --verbose verbose output + --verboseLog verbose logging +``` + +### SEE ALSO +* [hugo](/commands/hugo/) - hugo builds your site + - ###### Auto generated by spf13/cobra on 22-Jun-2017 ++###### Auto generated by spf13/cobra on 29-Jun-2017 diff --cc docs/content/community/contributing.md index 98530f4b,00000000..05231191 mode 100644,000000..100644 --- a/docs/content/community/contributing.md +++ b/docs/content/community/contributing.md @@@ -1,111 -1,0 +1,111 @@@ +--- +aliases: +- /doc/contributing/ +- /meta/contributing/ +lastmod: 2015-02-12 +date: 2013-07-01 +menu: + main: + parent: community +next: /tutorials/automated-deployments +prev: /community/mailing-list +title: Contributing to Hugo +weight: 30 +--- + +All contributions to Hugo are welcome. Whether you want to scratch an itch or simply contribute to the project, feel free to pick something from the [roadmap]({{< relref "meta/roadmap.md" >}}) or contact the dev team via the [Forums](https://discourse.gohugo.io/) or [Gitter](https://gitter.im/gohugoio/hugo) about what may make sense to do next. + +You should fork the project and make your changes. *We encourage pull requests to discuss code changes.* + + +When you're ready to create a pull request, be sure to: + + * Have test cases for the new code. If you have questions about how to do it, please ask in your pull request. + * Run `go fmt`. + * Squash your commits into a single commit. `git rebase -i`. It's okay to force update your pull request. + * Run `make check` and ensure it succeeds. [Travis CI](https://travis-ci.org/gohugoio/hugo) and [Appveyor](https://ci.appveyor.com/project/gohugoio/hugo) will runs these checks and fail the build if `make check` fails. + +## Contribution Overview + +We wrote a [detailed guide]({{< relref "tutorials/how-to-contribute-to-hugo.md" >}}) for newcomers that guides you step by step to your first contribution. If you are more experienced, follow the guide below. + + +# Building from source + +## Vendored Dependencies + +Hugo uses [govendor][] to vendor dependencies, but we don't commit the vendored packages themselves to the Hugo git repository. +Therefore, a simple `go get` is not supported since `go get` is not vendor-aware. +You **must use govendor** to fetch Hugo's dependencies. + +## Fetch the Sources + + go get github.com/kardianos/govendor + govendor get github.com/gohugoio/hugo + +## Running Hugo + + cd $HOME/go/src/github.com/gohugoio/hugo + go run main.go + +## Building Hugo + + cd $HOME/go/src/github.com/gohugoio/hugo + make build + # or to install to $HOME/go/bin: + make install + + +# Showcase additions + +You got your new website running and it's powered by Hugo? Great. You can add your website with a few steps to the [showcase](/showcase/). + - First, make sure that you created a [fork](https://help.github.com/articles/fork-a-repo/) of Hugo on GitHub and cloned your fork on your local computer. Next, create a separate branch for your additions: ++First, make sure that you created a [fork](https://help.github.com/articles/fork-a-repo/) of the [`hugoDocs`](https://github.com/gohugoio/hugodocs) repository on GitHub and cloned your fork on your local computer. **Next, create a separate branch for your additions**: + +``` +# You can choose a different descriptive branch name if you like +git checkout -b showcase-addition +``` + +Let's create a new document that contains some metadata of your homepage. Replace `example` in the following examples with something unique like the name of your website. Inside the terminal enter the following commands: + +``` +cd docs +hugo new showcase/example.md +``` + +You should find the new file at `content/showcase/example.md`. Open it in an editor. The file should contain a frontmatter with predefined variables like below: + +``` +--- +date: 2016-02-12T21:01:18+01:00 +description: "" +license: "" +licenseLink: "" +sitelink: http://spf13.com/ +sourceLink: https://github.com/spf13/spf13.com +tags: +- personal +- blog +thumbnail: /img/spf13-tn.jpg +title: example +--- +``` + +Add at least values for `sitelink`, `title`, `description` and a path for `thumbnail`. + - Furthermore, we need to create the thumbnail of your website. **It's important that the thumbnail has the required dimensions of 600px by 400px.** Give your thumbnail a name like `example-tn.png`. Save it under `docs/static/img/`. ++Furthermore, we need to create the thumbnail of your website. **It's important that the thumbnail has the required dimensions of 600px by 400px.** Give your thumbnail a name like `example-tn.png`. Save it under `static/img/`. + +Check a last time that everything works as expected. Start Hugo's built-in server in order to inspect your local copy of the showcase in the browser: + + hugo server + +If everything looks fine, we are ready to commit your additions. For the sake of best practices, please make sure that your commit follows our [code contribution guideline](https://github.com/gohugoio/hugo#code-contribution-guideline). + - git commit -m"docs: Add example.com to the showcase" ++ git commit -m"Add example.com to the showcase" + - Last but not least, we're ready to create a [pull request](https://github.com/gohugoio/hugo/compare). ++Last but not least, we're ready to create a [pull request](https://github.com/gohugoio/hugoDocs/compare). + +Don't forget to accept the contributor license agreement. Click on the yellow badge in the automatically added comment in the pull request. + +[govendor]: https://github.com/kardianos/govendor diff --cc docs/content/extras/gitinfo.md index d29641bc,00000000..d267e0e3 mode 100644,000000..100644 --- a/docs/content/extras/gitinfo.md +++ b/docs/content/extras/gitinfo.md @@@ -1,50 -1,0 +1,54 @@@ +--- +aliases: +- /doc/gitinfo/ +lastmod: 2016-12-11 +date: 2016-12-11 +menu: + main: + parent: extras +next: /extras/livereload +prev: /extras/datadrivencontent +title: GitInfo +--- + +Hugo provides a way to integrate Git data into your site. + + +## Prerequisites + +1. The Hugo site must be in a Git-enabled directory. +1. The Git executable must be installed and in your system `PATH`. +1. Enable the GitInfo feature in Hugo by using `--enableGitInfo` on the command + line or by setting `enableGitInfo` to `true` in your site configuration. + +## The GitInfo Object + +The `GitInfo` object contains the following fields: + +AbbreviatedHash +: abbreviated commit hash, e.g. `866cbcc` + +AuthorName +: author name, respecting `.mailmap` + +AuthorEmail +: author email address, respecting `.mailmap` + +AuthorDate +: the author date + +Hash +: commit hash, e.g. `866cbccdab588b9908887ffd3b4f2667e94090c3` + +Subject +: commit message subject, e.g. `tpl: Add custom index function` + + - ## Performance Considerations ++## Other Considerations + +The Git integrations should be fairly performant, but it does add some time to the build, which depends somewhat on the Git history size. + ++The accuracy of data depends on the underlying local git respository. If the local repository is a *shallow clone*, then any file that hasn't been modified in the truncated history will default to data in the oldest commit. In particular, if the respository has been cloned using `--depth=1` then every file will the exact same `GitInfo` data -- that of the only commit in the repository. ++ ++In particular, many CI/CD systems such as [travis-ci.org](https://travis-ci.org) default to a clone depth of 50 which is unlikely to be deep enough. You can explicitly add back the missing history using using `git fetch --unshallow` or [make the initial checkout deeper](https://docs.travis-ci.com/user/customizing-the-build#Git-Clone-Depth). ++ diff --cc docs/content/overview/installing.md index 895fae2a,00000000..fb7315c1 mode 100644,000000..100644 --- a/docs/content/overview/installing.md +++ b/docs/content/overview/installing.md @@@ -1,147 -1,0 +1,149 @@@ + +--- +aliases: +- /doc/installing/ +lastmod: 2016-01-04 +date: 2013-07-01 +menu: + main: + parent: getting started +next: /overview/usage +prev: /overview/quickstart +title: Installing Hugo +weight: 20 +--- + +Hugo is written in [Go][] with support for multiple platforms. + +The latest release can be found at [Hugo Releases](https://github.com/gohugoio/hugo/releases). +We currently provide pre-built binaries for + Windows, + Linux, + FreeBSD +and  OS X (Darwin) +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 DragonFly BSD, OpenBSD, Plan 9 and Solaris. See http://golang.org/doc/install/source for the full set of supported combinations of target operating systems and compilation architectures. + +## Installing Hugo (binary) + +Installation is very easy. Simply download the appropriate version for your +platform from [Hugo Releases](https://github.com/gohugoio/hugo/releases). +Once downloaded it can be run from anywhere. You don't need to install +it into a global location. This works well for shared hosts and other systems +where you don't have a privileged account. + +Ideally, you should install it somewhere in your `PATH` for easy use. +`/usr/local/bin` is the most probable location. + +On macOS, if you have [Homebrew](http://brew.sh/), installation is even +easier: just run `brew install hugo`. + +For a more detailed explanation follow the corresponding installation guides: + +- [Installation on macOS]({{< relref "tutorials/installing-on-mac.md" >}}) +- [Installation on Windows]({{< relref "tutorials/installing-on-windows.md" >}}) + +### Installing Pygments (optional) + +The Hugo executable has one *optional* external dependency for source code highlighting (Pygments). + +If you want to have source code highlighting using the [highlight shortcode](/extras/highlighting/), +you need to install the Python-based Pygments program. The procedure is outlined on the [Pygments home page](http://pygments.org/). + +## Upgrading Hugo + +Upgrading Hugo is as easy as downloading and replacing the executable you’ve +placed in your `PATH`. + +On macOS, if you have [Homebrew](http://brew.sh/), upgrading is even +easier: just run `brew upgrade hugo`. + +## Installing Hugo on Linux from native packages + +### Arch Linux + +You can install Hugo from the [Arch user repository](https://aur.archlinux.org/) on Arch Linux or derivatives such as Manjaro. + + sudo pacman -S yaourt + yaourt -S hugo + +Be aware that Hugo is built from source. This means that additional tools like [Git](https://git-scm.com/) and [Go](https://golang.org/doc/install) will be installed as well. + +### Debian and Ubuntu + +Hugo has been included in Debian and Ubuntu since 2016, and thus installing Hugo is as simple as: + + sudo apt install hugo + +Pros: + +* Native Debian/Ubuntu package maintained by Debian Developers +* Pre-installed bash completion script and man pages for best interactive experience + +Cons: + +* Might not be the latest version, especially if you are using an older stable version (e.g., Ubuntu 16.04 LTS). + Until backports and PPA are available, you may consider installing the Hugo snap package to get the latest version of Hugo, as described below. + +### Fedora, CentOS and Red Hat + +* https://copr.fedorainfracloud.org/coprs/daftaupe/hugo/ : updated as soon as possible after the official Hugo release. +* https://copr.fedorainfracloud.org/coprs/spf13/Hugo/ (updated to Hugo v0.16) + +See also [this discussion](https://discourse.gohugo.io/t/solved-fedora-copr-repository-out-of-service/2491). + +## Alternate Installation Methods + +### Snap Package + +In any of the [Linux distributions that support snaps](http://snapcraft.io/docs/core/install): + + snap install hugo + +> Note: Hugo-as-a-snap can write only inside the user’s `$HOME` directory—and gvfs-mounted directories owned by the user—because of Snaps’ confinement and security model. +> More information is also available [in this related GitHub issue](https://github.com/gohugoio/hugo/issues/3143). + +### Docker Image (unofficial) + +[Docker Hugo](https://hub.docker.com/r/felicianotech/docker-hugo/) is a Docker image that can be used for local development but more importantly, can be easily used for continuous integration builds of your Hugo site on [CircleCI](https://circleci.com/) or [Travis CI](https://travis-ci.org/). Source available on [GitHub](https://github.com/felicianotech/docker-hugo). + +## Installing from source + +### Prerequisite tools for downloading and building source code + +* [Git](http://git-scm.com/) +* [Go][] 1.8+ +* [govendor][] + +### Vendored Dependencies + +Hugo uses [govendor][] to vendor dependencies, but we don't commit the vendored packages themselves to the Hugo git repository. +Therefore, a simple `go get` is not supported since `go get` is not vendor-aware. +You **must use govendor** to fetch Hugo's dependencies. + +### Fetch from GitHub ++ ++ The commands below assume that you have [Go](https://golang.org/dl/) installed with your `$GOPATH` set. + + go get github.com/kardianos/govendor + govendor get github.com/gohugoio/hugo + +`govendor get` will fetch Hugo and all its dependent libraries to - `$HOME/go/src/github.com/gohugoio/hugo`, and compile everything into a final `hugo` ++`$GOPATH/src/github.com/gohugoio/hugo`, and compile everything into a final `hugo` +(or `hugo.exe`) executable, which you will find sitting inside - `$HOME/go/bin/`, all ready to go! ++`$GOPATH/go/bin/`, all ready to go! + +*Windows users: where you see the `$HOME` environment variable above, replace it with `%USERPROFILE%`.* + + +*Note: For syntax highlighting using the [highlight shortcode](/extras/highlighting/), +you need to install the Python-based [Pygments](http://pygments.org/) program.* + +## Contributing + +Please see the [contributing guide](/doc/contributing/) if you are interested in +working with the Hugo source or contributing to the project in any way. + +[Go]: http://golang.org/ +[govendor]: https://github.com/kardianos/govendor diff --cc docs/content/release-notes/0.24.1-relnotes.md index 1c7e57c7,00000000..438c5c43 mode 100644,000000..100644 --- a/docs/content/release-notes/0.24.1-relnotes.md +++ b/docs/content/release-notes/0.24.1-relnotes.md @@@ -1,23 -1,0 +1,23 @@@ + +--- +date: 2017-06-24 +title: 0.24.1 +--- + + + - This release fixes some important **archetype-related regressions** from the recent Hugo 0.24-relase. ++This release fixes some important **archetype-related regressions** from the recent Hugo 0.24-release. + +## Fixes + +* Fix archetype regression when no archetype file [4294dd8d](https://github.com/gohugoio/hugo/commit/4294dd8d9d22bd8107b7904d5389967da1f83f27) [@bep](https://github.com/bep) [#3626](https://github.com/gohugoio/hugo/issues/3626) +* Preserve shortcodes in archetype templates [b63e4ee1](https://github.com/gohugoio/hugo/commit/b63e4ee198c875b73a6a9af6bb809589785ed589) [@bep](https://github.com/bep) [#3623](https://github.com/gohugoio/hugo/issues/3623) +* Fix handling of timezones with positive UTC offset (e.g., +0800) in TOML [0744f81e](https://github.com/gohugoio/hugo/commit/0744f81ec00bb8888f59d6c8b5f57096e07e70b1) [@bep](https://github.com/bep) [#3628](https://github.com/gohugoio/hugo/issues/3628) + +## Enhancements + +* Create default archetype on new site [bfa336d9](https://github.com/gohugoio/hugo/commit/bfa336d96173377b9bbe2298dbd101f6a718c174) [@bep](https://github.com/bep) [#3626](https://github.com/gohugoio/hugo/issues/3626) + + + + diff --cc docs/content/showcase/christianmendoza.md index 6d18735d,00000000..6b36a53d mode 100644,000000..100644 --- a/docs/content/showcase/christianmendoza.md +++ b/docs/content/showcase/christianmendoza.md @@@ -1,14 -1,0 +1,14 @@@ +--- ++lastmod: 2017-06-30 +date: 2016-10-16T13:30:47-04:00 - date: 2016-12-20T17:21:00-05:00 +description: "Personal site" +license: "" +licenseLink: "" - sitelink: https://christianmendoza.me/ ++sitelink: https://www.christianmendoza.me/ +sourceLink: https://github.com/christianmendoza/christianmendoza.me +tags: +- personal +- profile +thumbnail: /img/christianmendoza-tn.jpg +title: christianmendoza.me +--- diff --cc docs/content/showcase/invincible.md index 00000000,00000000..2030e93f new file mode 100644 --- /dev/null +++ b/docs/content/showcase/invincible.md @@@ -1,0 -1,0 +1,15 @@@ ++--- ++date: 2017-07-01T01:11:00Z ++description: "The Invincible: The tale of a disillusioned prince" ++license: "Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License" ++licenseLink: "https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode" ++sitelink: https://invincible.site/ ++sourceLink: https://github.com/shazic/the_invincible ++tags: ++- personal ++- blog ++- graphic novel ++thumbnail: /img/invincible-tn.jpg ++title: Invincible ++--- ++ diff --cc docs/content/taxonomies/templates.md index 0a44d5b1,00000000..fdb6cd53 mode 100644,000000..100644 --- a/docs/content/taxonomies/templates.md +++ b/docs/content/taxonomies/templates.md @@@ -1,26 -1,0 +1,40 @@@ +--- +aliases: +- /indexes/templates/ +lastmod: 2014-05-29 +date: 2013-07-01 +linktitle: Templates +menu: + main: + parent: taxonomy +next: /taxonomies/ordering +prev: /templates/displaying +title: Taxonomy Templates +weight: 30 +--- + - There are two different templates that the use of taxonomies will require you to provide. ++Taxonomy templates should be placed in the folder `layouts/taxonomy`. ++When Taxonomy term template is provided for a Taxonomy, a section is rendered for it at `/SINGULAR/`. (eg. `/tag/` or `/category/`) + - Both templates are covered in detail in the templates section. ++There are two different templates that the use of taxonomies will require you to provide: + - A [list template](/templates/list/) is any template that will be used to render multiple pieces of - content in a single html page. This template will be used to generate - all the automatically created taxonomy pages. ++### All content attached to taxonomy + - A [taxonomy terms template](/templates/terms/) is a template used to - generate the list of terms for a given template. ++A [taxonomy terms template](/templates/terms/) is a template which has access to all the full Taxonomy structure. ++This Template is commonly used to generate the list of terms for a given template. + ++ ++#### layouts/taxonomy/SINGULAR.terms.html ++ ++For example: `tag.terms.html`, `category.terms.html`, or your custom Taxonomy: `actor.terms.html` ++ ++### All content attached to term ++ ++A [list template](/templates/list/) is used to automatically generate pages for each unique term found. ++ ++ ++#### layouts/taxonomy/SINGULAR.html ++ ++For example: `tag.html`, `category.html`, or your custom Taxonomy: `actor.html` ++ ++Terms are rendered at `SINGULAR/TERM/`. (eg. `/tag/book/` or `/category/news/`) diff --cc docs/layouts/partials/footer.html index 9734aa98,00000000..6f997644 mode 100644,000000..100644 --- a/docs/layouts/partials/footer.html +++ b/docs/layouts/partials/footer.html @@@ -1,59 -1,0 +1,59 @@@ +
+
-

Last revision: {{ .Lastmod.Format "January 2, 2006" }}{{ if .IsPage }}{{ with .GitInfo }} | {{ .Subject }} ({{ .AbbreviatedHash }}){{end }}{{ end }} ++

Last revision: {{ .Lastmod.Format "January 2, 2006" }}{{ if .IsPage }}{{ with .GitInfo }} | {{ .Subject }} ({{ .AbbreviatedHash }}){{end }}{{ end }} + Hugo v{{ .Site.Params.release }} documentation +

+ {{ with getenv "REPOSITORY_URL" -}} + + + + {{- end }} +
+
+ + + + + + +
+ {{ if .IsPage }} + {{ with .GetParam "next" }} + + {{ end }} + {{ end }} +
+ + + + + + + + + + + + + + + + + + + + + {{ template "partials/analytics.html" . }} + + diff --cc docs/layouts/section/showcase.html index b21e9835,00000000..be13fc61 mode 100644,000000..100644 --- a/docs/layouts/section/showcase.html +++ b/docs/layouts/section/showcase.html @@@ -1,17 -1,0 +1,17 @@@ +{{ partial "header.html" . }} + +

Hugo-built Sites (with source)

+ +
+ {{ range .Data.Pages.ByDate }} + {{ .Render "thumbnail"}} + {{ end }} +
+ +
+ +
- If you want to be added to this page, please send a pull request. Check out the how-to guide. ++If you want to be added to this page, please send a pull request. Check out the how-to guide. +
+ +{{ partial "footer.html" . }} diff --cc docs/static/img/christianmendoza-tn.jpg index 434d9dc5,00000000..82b45afa mode 100644,000000..100644 Binary files differ diff --cc docs/static/img/invincible-tn.jpg index 00000000,00000000..f8c11f82 new file mode 100644 Binary files differ