Squashed 'docs/' content from commit 5d9a6703

git-subtree-dir: docs git-subtree-split: 5d9a6703591c29283800d7b9e4c5c85981ed86d6
gohugoio · Jun 26, 2017 · dd78d5b · dd78d5b
commit dd78d5b
Show file tree

Hide file tree

Showing 491 changed files with 27,233 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+/.idea
+/public
diff --git a/README.md b/README.md
@@ -0,0 +1,3 @@
+# Hugo Docs
+
+Documentation site for [Hugo](https://github.com/gohugoio/hugo), the very fast and flexible static site generator built with love in GoLang.
diff --git a/archetypes/default.md b/archetypes/default.md
@@ -0,0 +1,6 @@
++++
+weight = 5
+[menu]
+  [menu.main]
+    parent = "x"
++++
diff --git a/archetypes/showcase.md b/archetypes/showcase.md
@@ -0,0 +1,14 @@
+---
+date: 2013-07-01T07:32:00Z
+description: ""
+license: ""
+licenseLink: ""
+sitelink: http://spf13.com/
+sourceLink: https://github.com/spf13/spf13.com
+tags:
+- personal
+- blog
+thumbnail: /img/spf13-tn.jpg
+title: spf13.com
+---
+
diff --git a/config.toml b/config.toml
@@ -0,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"
+
+[taxonomies]
+  tag = "tags"
+  group = "groups"
+
+[[menu.main]]
+    name = "Download Hugo"
+    pre = "<i class='fa fa-download'></i>"
+    url = "https://github.com/gohugoio/hugo/releases"
+    weight = -200
+[[menu.main]]
+    name = "Site Showcase"
+    pre = "<i class='fa fa-cubes'></i>"
+    url = "/showcase/"
+    weight = -180
+[[menu.main]]
+    name = "Theme Showcase"
+    pre = "<i class='fa fa-puzzle-piece'></i>"
+    url = "http://themes.gohugo.io"
+    weight = -170
+[[menu.main]]
+    name = "Press & Articles"
+    pre = "<i class='fa fa-bullhorn'></i>"
+    url = "/community/press/"
+    weight = -160
+[[menu.main]]
+    name = "Discuss Hugo"
+    pre = "<i class='fa fa-comments'></i>"
+    url = "https://discourse.gohugo.io/"
+    weight = -150
+[[menu.main]]
+    name = "About Hugo"
+    identifier = "about"
+    pre = "<i class='fa fa-heart'></i>"
+    weight = -110
+[[menu.main]]
+    name = "Release Notes"
+     url = "/release-notes/"
+    pre = "<i class='fa fa-newspaper-o'></i>"
+    weight = -111
+[[menu.main]]
+    name = "Getting Started"
+    identifier = "getting started"
+    pre = "<i class='fa fa-road'></i>"
+    weight = -100
+[[menu.main]]
+    name = "Content"
+    identifier = "content"
+    pre = "<i class='fa fa-file-text'></i>"
+    weight = -90
+[[menu.main]]
+    name = "Themes"
+    identifier = "themes"
+    pre = "<i class='fa fa-desktop'></i>"
+    weight = -85
+[[menu.main]]
+    parent = "themes"
+    name = "Theme Showcase"
+    url = "http://themes.gohugo.io"
+    weight = -170
+[[menu.main]]
+    name = "Templates"
+    identifier = "layout"
+    pre = "<i class='fa fa-columns'></i>"
+    weight = -80
+[[menu.main]]
+    name = "Taxonomies"
+    identifier = "taxonomy"
+    pre = "<i class='fa fa-tags'></i>"
+    weight = -70
+[[menu.main]]
+    name = "Extras"
+    identifier = "extras"
+    pre = "<i class='fa fa-gift'></i>"
+    weight = -60
+[[menu.main]]
+    name = "Community"
+    identifier = "community"
+    pre = "<i class='fa fa-group'></i>"
+    weight = -50
+[[menu.main]]
+    parent = "community"
+    name = "Discussion Forum"
+    url = "https://discourse.gohugo.io/"
+    weight = 150
+[[menu.main]]
+    name = "Tutorials"
+    identifier = "tutorials"
+    pre = "<i class='fa fa-book'></i>"
+    weight = -40
+[[menu.main]]
+    name = "Troubleshooting"
+    identifier = "troubleshooting"
+    pre = "<i class='fa fa-wrench'></i>"
+    weight = -30
+[[menu.main]]
+    name = "Tools"
+    url = "/tools/"
+    pre = "<i class='fa fa-cogs'></i>"
+    weight = -25
+[[menu.main]]
+    name = "Hugo Cmd Reference"
+    identifier = "commands"
+    pre = "<i class='fa fa-space-shuttle'></i>"
+    weight = -20
+    url = "/commands/"
diff --git a/content/commands/hugo.md b/content/commands/hugo.md
@@ -0,0 +1,80 @@
+---
+date: 2017-06-22T21:51:29+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
diff --git a/content/commands/hugo_benchmark.md b/content/commands/hugo_benchmark.md
@@ -0,0 +1,72 @@
+---
+date: 2017-06-22T21:51:29+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
diff --git a/content/commands/hugo_check.md b/content/commands/hugo_check.md
@@ -0,0 +1,37 @@
+---
+date: 2017-06-22T21:51:29+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
diff --git a/content/commands/hugo_check_ulimit.md b/content/commands/hugo_check_ulimit.md
@@ -0,0 +1,41 @@
+---
+date: 2017-06-22T21:51:29+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