diff options
| author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2017-06-14 11:32:16 +0300 |
|---|---|---|
| committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2017-06-14 11:32:16 +0300 |
| commit | 8be3934b59216c235d54c8560309daaf10e959a2 (patch) | |
| tree | 6c6d2b5fae3bbf502e42b5cc27ea1c0068ab010e /docs/content | |
| parent | fbb25014e1306ce7127d53e5fc4fc49867790336 (diff) | |
docs: Remove
Docs site is moved to https://github.com/gohugoio/hugoDocs
Will be re-added here as a Git submodule.
Diffstat (limited to 'docs/content')
242 files changed, 0 insertions, 18435 deletions
diff --git a/docs/content/commands/hugo.md b/docs/content/commands/hugo.md deleted file mode 100644 index f50fa1d87..000000000 --- a/docs/content/commands/hugo.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 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 23-May-2017 diff --git a/docs/content/commands/hugo_benchmark.md b/docs/content/commands/hugo_benchmark.md deleted file mode 100644 index df7c0e24d..000000000 --- a/docs/content/commands/hugo_benchmark.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 23-May-2017 diff --git a/docs/content/commands/hugo_check.md b/docs/content/commands/hugo_check.md deleted file mode 100644 index 19c99f7ca..000000000 --- a/docs/content/commands/hugo_check.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -date: 2017-04-26T22:40:07+02:00 -title: "hugo check" -slug: hugo_check -url: /commands/hugo_check/ ---- -## hugo check - -Contains some verification checks - -### Synopsis - - -Contains some verification checks - -### 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 26-Apr-2017 diff --git a/docs/content/commands/hugo_check_ulimit.md b/docs/content/commands/hugo_check_ulimit.md deleted file mode 100644 index 550e07a1f..000000000 --- a/docs/content/commands/hugo_check_ulimit.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -date: 2017-04-26T22:40:07+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 -``` - -### 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 26-Apr-2017 diff --git a/docs/content/commands/hugo_config.md b/docs/content/commands/hugo_config.md deleted file mode 100644 index 3429f302e..000000000 --- a/docs/content/commands/hugo_config.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 23-May-2017 diff --git a/docs/content/commands/hugo_convert.md b/docs/content/commands/hugo_convert.md deleted file mode 100644 index 9d5429311..000000000 --- a/docs/content/commands/hugo_convert.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 23-May-2017 diff --git a/docs/content/commands/hugo_convert_toJSON.md b/docs/content/commands/hugo_convert_toJSON.md deleted file mode 100644 index 4d0c19957..000000000 --- a/docs/content/commands/hugo_convert_toJSON.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 23-May-2017 diff --git a/docs/content/commands/hugo_convert_toTOML.md b/docs/content/commands/hugo_convert_toTOML.md deleted file mode 100644 index c72a0513b..000000000 --- a/docs/content/commands/hugo_convert_toTOML.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 23-May-2017 diff --git a/docs/content/commands/hugo_convert_toYAML.md b/docs/content/commands/hugo_convert_toYAML.md deleted file mode 100644 index 8e8943ba8..000000000 --- a/docs/content/commands/hugo_convert_toYAML.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 23-May-2017 diff --git a/docs/content/commands/hugo_env.md b/docs/content/commands/hugo_env.md deleted file mode 100644 index d58467d81..000000000 --- a/docs/content/commands/hugo_env.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 23-May-2017 diff --git a/docs/content/commands/hugo_gen.md b/docs/content/commands/hugo_gen.md deleted file mode 100644 index 693029de7..000000000 --- a/docs/content/commands/hugo_gen.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 23-May-2017 diff --git a/docs/content/commands/hugo_gen_autocomplete.md b/docs/content/commands/hugo_gen_autocomplete.md deleted file mode 100644 index 6ea504dc7..000000000 --- a/docs/content/commands/hugo_gen_autocomplete.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 23-May-2017 diff --git a/docs/content/commands/hugo_gen_doc.md b/docs/content/commands/hugo_gen_doc.md deleted file mode 100644 index 2ca15e2e4..000000000 --- a/docs/content/commands/hugo_gen_doc.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 23-May-2017 diff --git a/docs/content/commands/hugo_gen_man.md b/docs/content/commands/hugo_gen_man.md deleted file mode 100644 index 3d69cda54..000000000 --- a/docs/content/commands/hugo_gen_man.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 23-May-2017 diff --git a/docs/content/commands/hugo_import.md b/docs/content/commands/hugo_import.md deleted file mode 100644 index 0e0b70e20..000000000 --- a/docs/content/commands/hugo_import.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 23-May-2017 diff --git a/docs/content/commands/hugo_import_jekyll.md b/docs/content/commands/hugo_import_jekyll.md deleted file mode 100644 index ae9ace841..000000000 --- a/docs/content/commands/hugo_import_jekyll.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 23-May-2017 diff --git a/docs/content/commands/hugo_list.md b/docs/content/commands/hugo_list.md deleted file mode 100644 index e9d983144..000000000 --- a/docs/content/commands/hugo_list.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 23-May-2017 diff --git a/docs/content/commands/hugo_list_drafts.md b/docs/content/commands/hugo_list_drafts.md deleted file mode 100644 index 0d921f6e0..000000000 --- a/docs/content/commands/hugo_list_drafts.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 23-May-2017 diff --git a/docs/content/commands/hugo_list_expired.md b/docs/content/commands/hugo_list_expired.md deleted file mode 100644 index 75bc39aed..000000000 --- a/docs/content/commands/hugo_list_expired.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 23-May-2017 diff --git a/docs/content/commands/hugo_list_future.md b/docs/content/commands/hugo_list_future.md deleted file mode 100644 index e6fb917bb..000000000 --- a/docs/content/commands/hugo_list_future.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 23-May-2017 diff --git a/docs/content/commands/hugo_new.md b/docs/content/commands/hugo_new.md deleted file mode 100644 index f3ef722e9..000000000 --- a/docs/content/commands/hugo_new.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 - -f, --format string frontmatter format (default "toml") - -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 23-May-2017 diff --git a/docs/content/commands/hugo_new_site.md b/docs/content/commands/hugo_new_site.md deleted file mode 100644 index eefc0a41d..000000000 --- a/docs/content/commands/hugo_new_site.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 23-May-2017 diff --git a/docs/content/commands/hugo_new_theme.md b/docs/content/commands/hugo_new_theme.md deleted file mode 100644 index a4c589ede..000000000 --- a/docs/content/commands/hugo_new_theme.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 23-May-2017 diff --git a/docs/content/commands/hugo_server.md b/docs/content/commands/hugo_server.md deleted file mode 100644 index 7593ed42e..000000000 --- a/docs/content/commands/hugo_server.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 23-May-2017 diff --git a/docs/content/commands/hugo_undraft.md b/docs/content/commands/hugo_undraft.md deleted file mode 100644 index a71cb8791..000000000 --- a/docs/content/commands/hugo_undraft.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 23-May-2017 diff --git a/docs/content/commands/hugo_version.md b/docs/content/commands/hugo_version.md deleted file mode 100644 index 5b88fbe8d..000000000 --- a/docs/content/commands/hugo_version.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -date: 2017-05-23T20:59:46+03: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 23-May-2017 diff --git a/docs/content/community/contributing.md b/docs/content/community/contributing.md deleted file mode 100644 index 44518d70f..000000000 --- a/docs/content/community/contributing.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -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://discuss.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: - -``` -# 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/`. - -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" - -Last but not least, we're ready to create a [pull request](https://github.com/gohugoio/hugo/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 --git a/docs/content/community/mailing-list.md b/docs/content/community/mailing-list.md deleted file mode 100644 index 60c680089..000000000 --- a/docs/content/community/mailing-list.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -lastmod: 2015-05-25 -date: 2013-07-01 -menu: - main: - parent: community -next: /community/contributing -prev: /extras/urls -title: Mailing List -weight: 10 ---- - -## Discussion Forum - -Hugo has its own [discussion forum](http://discuss.gohugo.io/) powered by [Discourse](http://www.discourse.org/). - -Please use this for all discussions, questions, etc. - -### Twitter - -Get the latest bite-sized news and themes from the Hugo community on Twitter by following [@gohugoio](http://twitter.com/gohugoio). - -## Mailing List - -Hugo has two mailing lists: - -### Announcements -Very low traffic. Only releases will be emailed here. - -https://groups.google.com/forum/#!forum/hugo-announce - -### Discussion (Archive) - -**This has been replaced with the [Hugo discussion forum](http://discuss.gohugo.io/).** - -It is available for archival purposes. - -https://groups.google.com/forum/#!forum/hugo-discuss - - -## Other Resources - -### GoNuts - -For general Go questions or discussion please refer to the Go mailing list. - -https://groups.google.com/forum/#!forum/golang-nuts - -### GitHub Issues - -https://github.com/gohugoio/hugo/issues diff --git a/docs/content/community/press.md b/docs/content/community/press.md deleted file mode 100644 index 89000cf8b..000000000 --- a/docs/content/community/press.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -lastmod: 2017-03-02 -date: 2014-03-24T20:00:00Z -linktitle: Press -notoc: true -title: Press, Blogs and Media Coverage -weight: 20 ---- - -### Help keep this list up to date - -Know of a post, article or tutorial on Hugo? [Add it to this list](https://github.com/gohugoio/hugo/edit/master/docs/content/community/press.md). - -## Press and Articles - -Hugo has been featured in the following Blog Posts, Press and Media. - - -| Title | Author | Date | -| ------ | ------ | -----: | -| [Hugo Easy Gallery - Automagical PhotoSwipe image gallery with a one-line shortcode](https://www.liwen.id.au/heg/)| Li-Wen Yip | 2017-03-25 | -| [Hugo Tutorial: How to Build & Host a (Very Fast) Static E-Commerce Site](https://snipcart.com/blog/hugo-tutorial-static-site-ecommerce) | Snipcart | 2017-03-12 | -| [Automagical image gallery in Hugo with PhotoSwipe and jQuery](https://www.liwen.id.au/photoswipe/)| Li-Wen Yip | 2017-03-04 | -| [Adding Isso Comments to Hugo](https://stiobhart.net/2017-02-24-isso-comments/) | Stíobhart Matulevicz | 2017-02-24 | -| [Zero to HTTP/2 with AWS and Hugo](https://habd.as/zero-to-http-2-aws-hugo/) | Josh Habdas | 2017-02-16 | -| [How to Password Protect a Hugo Site](https://www.aerobatic.com/blog/password-protect-a-hugo-site/) | Aerobatic | 2017-02-19 | -| [Switching from Wordpress to Hugo](http://schnuddelhuddel.de/switching-from-wordpress-to-hugo/) | Mario Martelli | 2017-02-19 | ] -| [Deploy a Hugo site to Aerobatic with CircleCI ](https://www.aerobatic.com/blog/hugo-github-circleci/) | Aerobatic | 2017-02-14 | -| [NPM scripts for building and deploying Hugo site](https://www.aerobatic.com/blog/hugo-npm-buildtool-setup/) | Aerobatic | 2017-02-12 | -| [Getting started with Hugo and the plain-blog theme, on NearlyFreeSpeech.Net](https://www.penwatch.net/cms/get_started_plain_blog/) | Li-aung “Lewis” Yip | 2017-02-12 | -| [Build a Hugo site using Cloud9 IDE and host on App Engine](https://loyall.ch/lab/2017/01/build-a-static-website-with-cloud9-hugo-and-app-engine/)| Pascal Aubort | 2017-02-05 | -| [Hugo Continuous Deployment with Bitbucket Pipelines and Aerobatic](https://www.aerobatic.com/blog/hugo-bitbucket-pipelines/) | Aerobatic | 2017-02-04 | -| [How to use Firebase to host a Hugo site](https://www.m0d3rnc0ad.com/post/static-site-firebase/) | Andrew Cuga | 2017-02-04 | -| [A publishing workflow for teams using static site generators](https://www.keybits.net/post/publishing-workflow-for-teams-using-static-site-generators/) | Tom Atkins | 2017-01-02 | -| [How To Dynamically Use Google Fonts In A Hugo Website](https://stoned.io/web-development/hugo/How-To-Dynamically-Use-Google-Fonts-In-A-Hugo-Website/) | Hash Borgir | 2016-10-27 | -| [Embedding Facebook In A Hugo Template](https://stoned.io/web-development/hugo/Embedding-Facebook-In-A-Hugo-Template/) | Hash Borgir | 2016-10-22 | -| [通过 Gitlab-cl 将 Hugo blog 自动部署至 GitHub](https://zetaoyang.github.io/post/2016/10/17/gitlab-cl.html) <small>(Chinese, Continious integration)</small> | Zetao Yang | 2016-10-17 | -| [A Step-by-Step Guide: Hugo on Netlify](https://www.netlify.com/blog/2016/09/21/a-step-by-step-guide-hugo-on-netlify/) | Eli Williamson | 2016-09-21 | -| [Building our site: From Django & Wordpress to a static generator (Part I)](https://tryolabs.com/blog/2016/09/20/building-our-site-django-wordpress-to-static-part-i/) | Alan Descoins | 2016-09-20 | -| [Webseitenmaschine - Statische Websites mit Hugo erzeugen](http://www.heise.de/ct/ausgabe/2016-12-Statische-Websites-mit-Hugo-erzeugen-3211704.html) <small>(German, $)</small> | Christian Helmbold | 2016-05-27 | -| [Cómo hacer sitios web estáticos con Hugo y Go - Platzi](https://www.youtube.com/watch?v=qaXXpdiCHXE) <small>(Video tutorial)</small> | Verónica López | 2016-04-06 | -| [CDNOverview: A CDN comparison site made with Hugo](https://www.cloakfusion.com/cdnoverview-cdn-comparison-site-made-hugo/) | Thijs de Zoete | 2016-02-23 | -| [Hugo: A Modern WebSite Engine That Just Works](https://github.com/shekhargulati/52-technologies-in-2016/blob/master/07-hugo/README.md) | Shekhar Gulati | 2016-02-14 | -| [Minify Hugo Generated HTML](http://ratson.name/blog/minify-hugo-generated-html/) | Ratson | 2016-02-02 | -| [<span lang="ja">HugoのデプロイをWerckerからCircle CIに変更した</span> - log](http://log.deprode.net/logs/2016-01-17/) | Deprode | 2016-01-17 | -| [Static site generators: el futuro de las webs estáticas<br>(Hugo, Jekyll, Flask y otros)](http://sitelabs.es/static-site-generators-futuro-las-webs-estaticas/) | Eneko Sarasola | 2016-01-09 | -| [Writing a Lambda Function for Hugo](https://blog.jolexa.net/post/writing-a-lambda-function-for-hugo/) | Jeremy Olexa | 2016-01-01 | -| [Ein Blog mit Hugo erstellen - Tutorial](http://privat.albicker.org/tags/hugo.html) <small>(Deutsch/German)</small> | Bernhard Albicker | 2015-12-30 | -| [How to host Hugo static website generator on AWS Lambda](http://bezdelev.com/post/hugo-aws-lambda-static-website/) | Ilya Bezdelev | 2015-12-15 | -| [Migrating from Pelican to Hugo](http://www.softinio.com/post/migrating-from-pelican-to-hugo/) | Salar Rahmanian | 2015-11-29 | -| [Static Website Generators Reviewed: Jekyll, Middleman, Roots, Hugo](http://www.smashingmagazine.com/2015/11/static-website-generators-jekyll-middleman-roots-hugo-review/) | Mathias Biilmann Christensen | 2015-11-16 | -| [How To Deploy a Hugo Site to Production with Git Hooks on Ubuntu 14.04](https://www.digitalocean.com/community/tutorials/how-to-deploy-a-hugo-site-to-production-with-git-hooks-on-ubuntu-14-04) | Justin Ellingwood | 2015-11-12 | -| [How To Install and Use Hugo, a Static Site Generator, on Ubuntu 14.04](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-hugo-a-static-site-generator-on-ubuntu-14-04) | Justin Ellingwood | 2015-11-09 | -| [Switching from Wordpress to Hugo](http://justinfx.com/2015/11/08/switching-from-wordpress-to-hugo/) | Justin Israel | 2015-11-08 | -| [Hands-on Experience with Hugo as a Static Site Generator](http://usersnap.com/blog/hands-on-experience-with-hugo-static-site-generator/) | Thomas Peham | 2015 -10-15 | -| [Statische Webseites mit Hugo erstellen/Vortrag mit Foliensatz (deutsch)](http://sfd.koelnerlinuxtreffen.de/2015/HaraldWeidner/) | Harald Weidner | 2015-09-19 | -| [Moving from WordPress to Hugo](http://abhipandey.com/2015/09/moving-to-hugo/) | Abhishek Pandey | 2015-09-15 | -| [<span lang="zh-CN">通过webhook将Hugo自动部署至GitHub Pages和GitCafe Pages</span> <small>(Automated deployment)</small>](http://blog.coderzh.com/2015/09/13/use-webhook-automated-deploy-hugo/) | CoderZh | 2015-09-13 | -| [<span lang="zh-CN">使用hugo搭建个人博客站点</span> <small>(Using Hugo to build a personal blog site)</small>](http://blog.coderzh.com/2015/08/29/hugo/) | CoderZh | 2015-08-29 | -| [Good-Bye Wordpress, Hello Hugo!](http://blog.arminhanisch.de/2015/08/blog-migration-zu-hugo/) <small>(German)</small> | Armin Hanisch | 2015-08-18 | -| [Générer votre site web statique avec Hugo <small>(Generate your static site with Hugo)<small>](http://www.linux-pratique.com/?p=191) | Benoît Benedetti | 2015-06-26 | -| [<span lang="ja">Hugo向けの新しいテーマを作った</span> <small>(I created a new theme for Hugo)<small>](https://yet.unresolved.xyz/blog/2016/10/03/how-to-make-of-hugo-theme/) | Daisuke Tsuji | 2015-06-20 | -| [Hugo - Gerando um site com conteúdo estático. (Portuguese Brazil)](http://blog.ffrizzo.com/posts/hugo/) | Fabiano Frizzo | 2015-06-02 | -| [An Introduction to Static Site Generators](http://davidwalsh.name/introduction-static-site-generators) | Eduardo Bouças | 2015-05-20 | -| [Hugo Still Rules](http://cheekycoder.com/2015/05/hugo-still-rules/) | Cheeky Coder | 2015-05-18 | -| [hugo - Static Site Generator](http://gscacco.github.io/post/hugo/) | G Scaccoio | 2015-05-04 | -| [<span lang="ja">WindowsでHugoを使う</span>](http://ureta.net/2015/05/hugo-on-windows/) | <span lang="ja">うれ太郎</span> | 2015-05-01 | -| [<span lang="ja">Hugoのshortcodesを用いてサイトにスライドなどを埋め込む</span>](http://blog.yucchiy.com/2015/04/29/hugo-shortcode/) | Yucchiy | 2015-04-29 | -| [<span lang="ja">HugoとCircleCIでGitHub PagesにBlogを公開してみたら超簡単だった</span>](http://hori-ryota.github.io/blog/create-blog-with-hugo-and-circleci/) | Hori Ryota | 2015-04-17 | -| [10 Best Static Site Generators](http://beebom.com/2015/04/best-static-site-generators) | Aniruddha Mysore | 2015-04-06 | -| [Goodbye WordPress; Hello Hugo](http://willwarren.com/2015/04/05/goodbye-wordpress-hello-hugo/) | Will Warren | 2015-04-05 | -| [Static Websites with Hugo on Google Cloud Storage](http://www.moxie.io/post/static-websites-with-hugo-on-google-cloud-storage/) | Moxie Input/Output | 2015-04-02 | -| [De nuevo iniciando un blog](https://alvarolizama.net/) | Alvaro Lizama | 2015-03-29 | -| [We moved our blog from Posthaven to Hugo after only three posts. Why?](http://blog.hypriot.com/post/moved-from-posthaven-to-hugo/) | Hypriot | 2015-03-27 | -| [Top Static Site Generators in 2015](http://superdevresources.com/static-site-generators-2015/) | Kanishk Kunal | 2015-03-12 | -| [Moving to Hugo](http://abiosoft.com/moving-to-hugo/) | Abiola Ibrahim | 2015-03-08 | -| [Migrating a blog (yes, this one!) from Wordpress to Hugo](http://justindunham.net/migrating-from-wordpress-to-hugo/) | Justin Dunham | 2015-02-13 | -| [<span lang="ja">blogをoctopressからHugoに乗り換えたメモ</span>](http://blog.jigyakkuma.org/2015/02/11/hugo/) | jigyakkuma | 2015-02-11 | -| [<span lang="ja">Hugoでブログをつくった</span>](http://porgy13.github.io/post/new-hugo-blog/) | porgy13 | 2015-02-07 | -| [<span lang="ja">Hugoにブログを移行した</span>](http://keichi.net/post/first/) | Keichi Takahashi | 2015-02-04 | -| [<span lang="zh-CN">Hugo静态网站生成器中文教程</span>](http://nanshu.wang/post/2015-01-31/) | Nanshu Wang | 2015-01-31 | -| [<span lang="ja">Hugo + GitHub Pages + Wercker CI = ¥0（無料）<br>でコマンド 1 発（自動化）でサイト<br>・ブログを公開・運営・分析・収益化</span>](http://qiita.com/yoheimuta/items/8a619cac356bed89a4c9) | Yohei Yoshimuta | 2015-01-31 | -| [Running Hugo websites on anynines](http://blog.anynines.com/running-hugo-websites-on-anynines/) | Julian Weber | 2015-01-30 | -| [MiddlemanからHugoへ移行した](http://re-dzine.net/2015/01/hugo/) | Haruki Konishi | 2015-01-21 | -| [WordPress から Hugo に乗り換えました](http://rakuishi.com/archives/wordpress-to-hugo/) | rakuishi | 2015-01-20 | -| [HUGOを使ってサイトを立ち上げる方法](http://qiita.com/syui/items/869538099551f24acbbf) | Syui | 2015-01-17 | -| [<span lang="ja">Jekyllが許されるのは小学生までだよね</span>](http://t32k.me/mol/log/hugo/) | Ishimoto Koji | 2015-01-16 | -| [Getting started with Hugo](http://anthonyfok.org/post/getting-started-with-hugo/) | Anthony Fok | 2015-01-12 | -| [<span lang="zh-CN">把这个博客静态化了</span> <small>(Migrate to Hugo)</small>](http://lich-eng.com/2015/01/03/migrate-to-hugo/)| Li Cheng | 2015-01-03 | -| [Porting my blog with Hugo](http://blog.srackham.com/posts/porting-my-blog-with-hugo/) | Stuart Rackham | 2014-12-30 | -| [Hugoを使ってみたときのメモ](http://machortz.github.io/posts/usinghugo/) | Machortz | 2014-12-29 | -| [OctopressからHugoへ移行した](http://deeeet.com/writing/2014/12/25/hugo/) | Taichi Nakashima | 2014-12-25 | -| [Migrating to Hugo From Octopress](http://nathanleclaire.com/blog/2014/12/22/migrating-to-hugo-from-octopress/) | Nathan LeClaire | 2014-12-22 | -| [Dynamic Pages with GoHugo.io](http://cyrillschumacher.com/2014/12/21/dynamic-pages-with-gohugo.io/) | Cyrill Schumacher | 2014-12-21 | -| [6 Static Blog Generators That Aren’t Jekyll](http://www.sitepoint.com/6-static-blog-generators-arent-jekyll/) | David Turnbull | 2014-12-08 | -| [Travel Blogging Setup](http://www.stou.dk/2014/11/travel-blogging-setup/) | Rasmus Stougaard | 2014-11-23 | -| [Hosting A Hugo Website Behind Nginx](http://www.bigbeeconsultants.co.uk/blog/hosting-hugo-website-behind-nginx) | Rick Beton | 2014-11-20 | -| [<span lang="zh-CN">使用Hugo搭建免费个人Blog</span> <small>(How to use Hugo)</small>](http://ulricqin.com/post/how-to-use-hugo/) | Ulric Qin <span lang="zh-CN">秦晓辉</span> | 2014-11-11 | -| [Built in Speed and Built for Speed by Hugo](http://cheekycoder.com/2014/10/built-for-speed-by-hugo/) | Cheeky Coder | 2014-10-30 | -| [Hugo para crear sitios web estáticos](http://www.webbizarro.com/noticias/1076/hugo-para-crear-sitios-web-estaticos/) | Web Bizarro | 2014-08-19 | -| [Going with hugo](http://www.markuseliasson.se/article/going-with-hugo/) | Markus Eliasson | 2014-08-18 | -| [Benchmarking Jekyll, Hugo and Wintersmith](http://fredrikloch.me/post/2014-08-12-Jekyll-and-its-alternatives-from-a-site-generation-point-of-view/) | Fredrik Loch | 2014-08-12 | -| [Goodbye Octopress, Hello Hugo!](http://andreimihu.com/blog/2014/08/11/goodbye-octopress-hello-hugo/) | Andrei Mihu | 2014-08-11 | -| [Beautiful sites for Open Source projects](http://beautifulopen.com/2014/08/09/hugo/) | Beautiful Open | 2014-08-09 | -| [Hugo: Beyond the Defaults](http://npf.io/2014/08/hugo-beyond-the-defaults/) | Nate Finch | 2014-08-08 | -| [First Impressions of Hugo](https://peteraba.com/blog/first-impressions-of-hugo/) | Peter Aba | 2014-06-06 | -| [New Site Workflow](http://vurt.co.uk/post/new_website/) | Giles Paterson | 2014-08-05 | -| [How I Learned to Stop Worrying and Love the (Static) Web](http://cognition.ca/post/about-hugo/) | Joshua McKenty | 2014-08-04 | -| [Hugo - Static Site Generator](http://kenwoo.io/blog/hugo---static-site-generator/) | Kenny Woo | 2014-08-03 | -| [Hugo Is Friggin' Awesome](http://npf.io/2014/08/hugo-is-awesome/) | Nate Finch | 2014-08-01 | -| [<span lang="zh-CN">再次搬家</span> <small>(Move from WordPress to Hugo)</small>](http://www.chingli.com/misc/move-from-wordpress-to-hugo/) | <span lang="zh-CN">青砾</span> (chingli) | 2014-07-12 | -| [Embedding Gists in Hugo](http://danmux.com/posts/embedded_gists/) | Dan Mull | 2014-07-05 | -| [An Introduction To Hugo](http://www.cirrushosting.com/web-hosting-blog/an-introduction-to-hugo/) | Dan Silber | 2014-07-01 | -| [Moving to Hugo](http://danmux.com/posts/hugo_based_blog/) | Dan Mull | 2014-05-29 | -| [<span lang="zh-CN">开源之静态站点生成器排行榜</span><br><small>(Leaderboard of open-source static website generators)</small>](http://code.csdn.net/news/2819909) | CSDN.net | 2014-05-23 | -| [Finally, a satisfying and effective blog setup](http://michaelwhatcott.com/now-powered-by-hugo/) | Michael Whatcott | 2014-05-20 | -| [Hugo from scratch](http://zackofalltrades.com/notes/2014/05/hugo-from-scratch/) | Zack Williams | 2014-05-18 | -| [Why I switched away from Jekyll](http://www.jakejanuzelli.com/why-I-switched-away-from-jekyll/) | Jake Januzelli | 2014-05-10 | -| [Welcome our new blog](http://blog.ninya.io/posts/welcome-our-new-blog/) | Ninya.io | 2014-04-11 | -| [Mission Not Accomplished](http://johnsto.co.uk/blog/mission-not-accomplished/) | Dave Johnston | 2014-04-03 | -| [Hugo - A Static Site Builder in Go](http://deepfriedcode.com/post/hugo/) | Deep Fried Code | 2014-03-30 | -| [Adventures in Angular Podcast](http://devchat.tv/adventures-in-angular/003-aia-gdes) | Matias Niemela | 2014-03-28 | -| [Hugo](http://bra.am/post/hugo/) | bra.am | 2014-03-23 | -| [Converting Blogger To Markdown](http://trishagee.github.io/project/atom-to-hugo/) | Trisha Gee | 2014-03-20 | -| [Moving to Hugo Static Web Pages](http://tepid.org/tech/hugo-web/) | Tobias Weingartner | 2014-03-16 | -| [New Blog Engine: Hugo](https://blog.afoolishmanifesto.com/posts/hugo/) | fREW Schmidt | 2014-03-15 | -| [Hugo + gulp.js = Huggle](http://ktmud.github.io/huggle/en/intro/) ([English](http://ktmud.github.io/huggle/en/intro/), [<span lang="zh-CN">中文</span>](http://ktmud.github.io/huggle/zh/intro/)) | Jesse Yang <span lang="zh-CN">杨建超</span> | 2014-03-08 | -| [Powered by Hugo](http://kieranhealy.org/blog/archives/2014/02/24/powered-by-hugo/) | Kieran Healy | 2014-02-24 | -| [<span lang="ja">静的サイトを素早く構築するために<br>GoLangで作られたジェネレータHugo</span>](http://hamasyou.com/blog/2014/02/21/hugo/)| <div lang="ja" style="line-height: 1.1;">Shogo Hamada<br>濱田章吾</div> | 2014-02-21 | -| [Latest Roundup of Useful Tools For Developers](http://codegeekz.com/latest-roundup-of-useful-tools-for-developers/) | CodeGeekz | 2014-02-13 | -| [Hugo: Static Site Generator written in Go](http://www.braveterry.com/2014/02/06/hugo-static-site-generator-written-in-go/) | Brave Terry | 2014-02-06 | -| [10 Useful HTML5 Tools for Web Designers and Developers](http://designdizzy.com/10-useful-html5-tools-for-web-designers-and-developers/) | Design Dizzy | 2014-02-04 | -| [Hugo – Fast, Flexible Static Site Generator](http://cube3x.com/hugo-fast-flexible-static-site-generator/) | Joby Joseph | 2014-01-18 | -| [Hugo: A new way to build static website](http://www.w3update.com/opensource/hugo-a-new-way-to-build-static-website.html) | w3update | 2014-01-17 | -| [Xaprb now uses Hugo](http://xaprb.com/blog/2014/01/15/using-hugo/) | Baron Schwartz | 2014-01-15 | -| [New jQuery Plugins And Resources That Web Designers Need](http://www.designyourway.net/blog/resources/new-jquery-plugins-and-resources-that-web-designers-need/) | Design Your Way | 2014-01-01 | -| [On Blog Construction](http://alexla.sh/post/on-blog-construction/) | Alexander Lash | 2013-12-27 | -| [Hugo](http://onethingwell.org/post/69070926608/hugo) | One Thing Well | 2013-12-05 | -| [In Praise Of Hugo](http://sound-guru.com/blog/post/hello-world/) | sound-guru.com | 2013-10-19 | -| [Hosting a blog on S3 and Cloudfront](http://www.danesparza.net/2013/07/hosting-a-blog-on-s3-and-cloudfront/) | Dan Esparza | 2013-07-24 | diff --git a/docs/content/content/archetypes.md b/docs/content/content/archetypes.md deleted file mode 100644 index 88efdbd0f..000000000 --- a/docs/content/content/archetypes.md +++ /dev/null @@ -1,330 +0,0 @@ ---- -lastmod: 2016-10-01 -date: 2014-05-14T02:13:50Z -menu: - main: - parent: content -next: /content/ordering -prev: /content/types -title: Archetypes -weight: 50 -toc: true ---- - -Typically, each piece of content you create within a Hugo project will have [front matter](/content/front-matter/) that follows a consistent structure. If you write blog posts, for instance, you might use the following front matter for the vast majority of those posts: - -```toml -+++ -title = "" -date = "" -slug = "" -tags = [ - "" -] -categories = [ - "" -] -draft = true -+++ -``` - -You can always add non-typical front matter to any piece of content, but since it takes extra work to develop a theme that handles unique metadata, consistency is simpler. - -With this in mind, Hugo has a convenient feature known as *archetypes* that allows users to define default front matter for new pieces of content. - -By using archetypes, we can: - -1. **Save time**. Stop writing the same front matter over and over again. -2. **Avoid errors**. Reduce the odds of typos, improperly formatted syntax, and other simple mistakes. -3. **Focus on more important things**. Avoid having to remember all of the fields that need to be associated with each piece of content. (This is particularly important for larger projects with complex front matter and a variety of content types.) - -Let's explore how they work. - -## Built-in Archetypes - -If you've been using Hugo for a while, there's a decent chance you've come across archetypes without even realizing it. This is because Hugo includes a basic, built-in archetype that is used by default whenever it generates a content file. - -To see this in action, open the command line, navigate into your project's directory, and run the following command: - -```bash -hugo new hello-world.md -``` - -This `hugo new` command creates a new content file inside the project's `content` directory — in this case, a file named `hello-world.md` — and if you open this file, you'll notice it contains the following front matter: - -```toml -+++ -date = "2017-05-31T15:18:11+10:00" -draft = true -title = "hello world" -+++ -``` - -Here, we can see that three fields have been added to the document: a `title` field that is based on the file name we defined, a `draft` field that ensures this content won't be published by default, and a `date` field that is auto-populated with the current date and time in the [RFC 3339](https://stackoverflow.com/questions/522251/whats-the-difference-between-iso-8601-and-rfc-3339-date-formats) format. - -This, in its most basic form, is an example of an archetype. To understand how useful they can be though, it's best if we create our own. - -## Creating Archetypes - -In this section, we're going to create an archetype that will override the built-in archetype, allowing us to define custom front matter that will be included in any content files that we generate with the `hugo new` command. - -To achieve this, create a file named `default.md` inside the `archetypes` folder of a Hugo project. (If the folder doesn't exist, create it.) - -Then, inside this file, define the following front matter: - -```toml -+++ -slug = "" -tags = [] -categories = [] -draft = true -+++ -``` - -You'll notice that we haven't defined a `title` or `date` field. This is because Hugo will automatically add these fields to the beginning of the front matter. We do, however, need to define the `draft` field if we want it to exist in our front matter. - -You'll also notice that we're writing the front matter in the TOML format. It's possible to define archetype front matter in other formats, but a setting needs to be changed in the configuration file for this to be possible. See the "[Archetype Formats](#archetype-formats)" section of this article for more details. - -Next, run the following command: - -```bash -hugo new my-archetype-example.md -``` - -This command will generate a file named `my-archetype-example.md` inside the `content` directory, and this file will contain the following output: - -```toml -+++ -categories = [] -date = "2017-05-31T15:21:13+10:00" -draft = true -slug = "" -tags = [] -title = "my archetype example" -+++ -``` - -As we can see, the file contains the `title` and `date` property that Hugo created for us, along with the front matter that we defined in the `archetypes/default.md` file. - -You'll also notice that the fields have been sorted into alphabetical order. This is an unintentional side-effect that stems from the underlying code libraries that Hugo relies upon. It is, however, [a known issue that is actively being discussed](https://github.com/gohugoio/hugo/issues/452). - -## Section Archetypes - -By creating the `archetypes/default.md` file, we've created a default archetype that is more useful than the built-in archetype, but since Hugo encourages us to [organize our content into sections](/content/sections/), each of which will likely have different front matter requirements, a "one-size-fits-all" archetype isn't necessarily the best approach. - -To accommodate for this, Hugo allows us to create archetypes for each section of our project. This means, whenever we generate content for a certain section, the appropriate front matter for that section will be automatically included in the generated file. - -To see this in action, create a "photo" section by creating a directory named "photo" inside the `content` directory. - -Then create a file named `photo.md` inside the `archetypes` directory and include the following front matter inside this file: - -```toml -+++ -image_url = "" -camera = "" -lens = "" -aperture = "" -iso = "" -draft = true -+++ -``` - -Here, the critical detail is that the `photo.md` file in the `archetypes` directory is named after the `photo` section that we just created. By sharing a name, Hugo can understand that there's a relationship between them. - -Next, run the following command: - -```bash -hugo new photo/my-pretty-cat.md -``` - -This command will generate a file named `my-pretty-cat.md` inside the `content/photo` directory, and this file will contain the following output: - -```toml -+++ -aperture = "" -camera = "" -date = "2017-05-31T15:25:18+10:00" -draft = true -image_url = "" -iso = "" -lens = "" -title = "my pretty cat" -+++ -``` - -As we can see, the `title` and `date` fields are still included by Hugo, but the rest of the front matter is being generated from the `photo.md` archetype instead of the `default.md` archetype. - -### Tip: Default Values - -To make archetypes more useful, define default values for any fields that will always be set to a range of limited options. In the case of the `photo.md` archetype, for instance, you could include lists of the various cameras and lenses that you own: - -```toml -+++ -image_url = "" -camera = [ - "Sony RX100 Mark IV", - "Canon 5D Mark III", - "iPhone 6S" -] -lens = [ - "Canon EF 50mm f/1.8", - "Rokinon 14mm f/2.8" -] -aperture = "" -iso = "" -draft = true -+++ -``` - -Then, after generating a content file, simply remove the values that aren't relevant. This saves you from typing out the same options over and over again while ensuring consistency in how they're written. - -## Scaffolding Content - -Archetypes aren't limited to defining default front matter. They can also be used to define a default structure for the body of Markdown documents. - -For example, imagine creating a `review.md` archetype for the purpose of writing camera reviews. This is what the front matter for such an archetype might look like: - -```toml -+++ -manufacturer = "" -model = "" -price = "" -releaseDate = "" -rating = "" -+++ -``` - -But reviews tend to follow strict formats and need to answer specific questions, and it's with these expectations of precise structure that archetypes can prove to be even more useful. - -For the sake of writing reviews, for instance, we could define the structure of a review beneath the front matter of the `review.md` file: - -```markdown -+++ -manufacturer = "" -model = "" -price = "" -releaseDate = "" -rating = "" -+++ - -## Introduction - -## Sample Photos - -## Conclusion -``` - -Then, whenever we use the `hugo new` command to create a new review, not only will the default front matter be copied into the newly created Markdown document, but the body of the `review.md` archetype will also be copied. - -To take this further though — and to ensure authors on multi-author websites are on the same page about how content should be written — we could include notes and reminders within the archetype: - -```markdown -+++ -manufacturer = "" -model = "" -price = "" -releaseDate = "" -rating = "" -+++ - -## Introduction - -<!-- - What is the selling point of the camera? - What has changed since last year's model? - Include a bullet-point list of key features. ---> - -## Sample Photos - -<!-- TODO: Take at least 12 photos in a variety of situations. --> - -## Conclusion - -<!-- - Is this camera worth the money? - Does it accomplish what it set out to achieve? - Are there any specific groups of people who should/shouldn't buy it? - Would you recommend it to a friend? - Are there alternatives on the horizon? ---> - -``` - -That way, each time we generate a new content file, we have a series of handy notes to push us closer to a piece of writing that's suitable for publishing. - -(If you're wondering why the notes are wrapped in the HTML comment syntax, it's to ensure they won't appear inside the preview window of whatever Markdown editor the author happens to be using. They're not strictly necessary though.) - -This is still a fairly simple example, but if your content usually contains a variety of components — headings, bullet-points, images, [short-codes](/extras/shortcodes/), etc — it's not hard to see the time-saving benefits of placing these components in the body of an archetype file. - -## Theme Archetypes - -Whenever you generate a content file with the `hugo new` command, Hugo will start by searching for archetypes in the `archetypes` directory, initially looking for an archetype that matches the content's section and falling-back on the `default.md` archetype (if one is present). If no archetypes are found in this directory, Hugo will continue its search in the `archetypes` directory of the currently active theme. In other words, it's possible for themes to come packaged with their own archetypes, ensuring that users of that theme format their content files with correctly structured front matter. - -To allow Hugo to use archetypes from a theme, [that theme must be activated via the project's configuration file](/themes/usage/): - -```toml -theme = "ThemeNameGoesHere" -``` - -If an archetype doesn't exist in the `archetypes` directory at the top-level of a project or inside the `archetypes` directory of an active theme, the built-in archetype will be used. - -{{< figure src="/img/content/archetypes/archetype-hierarchy.png" alt="How Hugo Decides Which Archetype To Use" >}} - -## Archetype Formats - -By default, the `hugo new` command will generate front matter in the TOML format. This means, even if we define the front matter in our archetype files as YAML or JSON, it will be converted to the TOML format before it ends up in our content files. - -Fortunately, this functionality can be overwritten. - -Inside the project's configuration file, simply define a `metaDataFormat` property: - -```toml -metaDataFormat = "" -``` - -Then set this property to any of the following values: - -* toml -* yaml -* json - -By defining this option, any front matter will be generated in your preferred format. - -It's worth noting, however, that when generating front matter in the TOML format, you might encounter the following error: - -```bash -Error: cannot convert type <nil> to TomlTree -``` - -This is because, to generate TOML, all of the fields in the front matter need to have a default value, even if that default value is just an empty string. - -For example, this YAML would *not* successfully compile into the TOML format: - -```yaml ---- -slug: -tags: -categories: -draft: ---- -``` - -But this YAML *would* successfully compile: - -```yaml ---- -slug: "" -tags: - - -categories: - - -draft: true ---- -``` - -It's a subtle yet important detail to remember. - -## Notes - -* Prior to Hugo v0.13, some users received [an "EOF" error when using archetypes](https://github.com/gohugoio/hugo/issues/776), related to what text editor they used to create the archetype. As of Hugo v0.13, this error has been [resolved](https://github.com/gohugoio/hugo/pull/785). diff --git a/docs/content/content/example.md b/docs/content/content/example.md deleted file mode 100644 index 022764994..000000000 --- a/docs/content/content/example.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -aliases: -- /doc/example/ -lastmod: 2015-12-23 -date: 2013-07-01 -linktitle: Example -menu: - main: - parent: content -prev: /content/multilingual -next: /content/using-index-md -notoc: true -title: Example Content File -weight: 70 ---- - -Some things are better shown than explained. The following is a very basic example of a content file written in [Markdown](https://help.github.com/articles/github-flavored-markdown/): - -**mysite/content/project/nitro.md → http://mysite.com/project/nitro.html** - -With TOML front matter: - -<pre><code class="language-toml">+++ -date = "2013-06-21T11:27:27-04:00" -title = "Nitro: A quick and simple profiler for Go" -description = "Nitro is a simple profiler for your Golang applications" -tags = [ "Development", "Go", "profiling" ] -topics = [ "Development", "Go" ] -slug = "nitro" -project_url = "https://github.com/spf13/nitro" -+++ -</code><code class="language-markdown"># Nitro - -Quick and easy performance analyzer library for [Go](http://golang.org/). - -## Overview - -Nitro is a quick and easy performance analyzer library for Go. -It is useful for comparing A/B against different drafts of functions -or different functions. - -## Implementing Nitro - -Using Nitro is simple. First, use `go get` to install the latest version -of the library. - - $ go get github.com/spf13/nitro - -Next, include nitro in your application. -</code></pre> - -You may also use the equivalent YAML front matter: - -```yaml ---- -lastmod: 2015-12-23 -date: "2013-06-21T11:27:27-04:00" -title: "Nitro: A quick and simple profiler for Go" -description: "Nitro is a simple profiler for your Go lang applications" -tags: [ "Development", "Go", "profiling" ] -topics: [ "Development", "Go" ] -slug: "nitro" -project_url: "https://github.com/spf13/nitro" ---- -``` - -`nitro.md` would be rendered as follows: - -> # Nitro -> -> Quick and easy performance analyzer library for [Go](http://golang.org/). -> -> ## Overview -> -> Nitro is a quick and easy performance analyzer library for Go. -> It is useful for comparing A/B against different drafts of functions -> or different functions. -> -> ## Implementing Nitro -> -> Using Nitro is simple. First, use `go get` to install the latest version -> of the library. -> -> $ go get github.com/spf13/nitro -> -> Next, include nitro in your application. - -The source `nitro.md` file is converted to HTML by the excellent -[Blackfriday](https://github.com/russross/blackfriday) Markdown processor, -which supports extended features found in the popular -[GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/). diff --git a/docs/content/content/front-matter.md b/docs/content/content/front-matter.md deleted file mode 100644 index e61a48f55..000000000 --- a/docs/content/content/front-matter.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -aliases: -- /doc/front-matter/ -lastmod: 2015-12-23 -date: 2013-07-01 -menu: - main: - parent: content -next: /content/sections -prev: /content/organization -title: Front Matter -weight: 20 -toc: true ---- - -The **front matter** is one of the features that gives Hugo its strength. It enables -you to include the meta data of the content right with it. Hugo supports a few -different formats, each with their own identifying tokens. - -Supported formats: - - * **[TOML][]**, identified by '`+++`'. - * **[YAML][]**, identified by '`---`'. - * **[JSON][]**, a single JSON object which is surrounded by '`{`' and '`}`', followed by a newline. - -[TOML]: https://github.com/toml-lang/toml "Tom's Obvious, Minimal Language" -[YAML]: http://www.yaml.org/ "YAML Ain't Markup Language" -[JSON]: http://www.json.org/ "JavaScript Object Notation" - -## TOML Example - -<pre><code class="language-toml">+++ -title = "spf13-vim 3.0 release and new website" -description = "spf13-vim is a cross platform distribution of vim plugins and resources for Vim." -tags = [ ".vimrc", "plugins", "spf13-vim", "vim" ] -date = "2012-04-06" -categories = [ - "Development", - "VIM" -] -slug = "spf13-vim-3-0-release-and-new-website" -+++ -</code><code class="language-markdown">Content of the file goes Here -</code></pre> - -## YAML Example - -```yaml ---- -title: "spf13-vim 3.0 release and new website" -description: "spf13-vim is a cross platform distribution of vim plugins and resources for Vim." -tags: [ ".vimrc", "plugins", "spf13-vim", "vim" ] -lastmod: 2015-12-23 -date: "2012-04-06" -categories: - - "Development" - - "VIM" -slug: "spf13-vim-3-0-release-and-new-website" ---- - -Content of the file goes Here -``` - -## JSON Example - -```json -{ - "title": "spf13-vim 3.0 release and new website", - "description": "spf13-vim is a cross platform distribution of vim plugins and resources for Vim.", - "tags": [ ".vimrc", "plugins", "spf13-vim", "vim" ], - "date": "2012-04-06", - "categories": [ - "Development", - "VIM" - ], - "slug": "spf13-vim-3-0-release-and-new-website" -} - -Content of the file goes Here -``` - -## Variables - -There are a few predefined variables that Hugo is aware of and utilizes. The user can also create -any variable they want. These will be placed into the `.Params` variable available to the templates. -Field names are always normalized to lowercase (e.g. `camelCase: true` is available as `.Params.camelcase`). - -### Required variables - -* **title** The title for the content -* **description** The description for the content -* **date** The date the content will be sorted by -* **taxonomies** These will use the field name of the plural form of the index (see tags and categories above) - -### Optional variables - -* **aliases** An array of one or more aliases - (e.g. old published path of a renamed content) - that would be created to redirect to this content. - See [Aliases]({{< relref "extras/aliases.md" >}}) for details. -* **draft** If true, the content will not be rendered unless `hugo` is called with `--buildDrafts` -* **publishdate** If in the future, content will not be rendered unless `hugo` is called with `--buildFuture` -* **expirydate** Content already expired will not be rendered unless `hugo` is called with `--buildExpired` -* **type** The type of the content (will be derived from the directory automatically if unset) -* **isCJKLanguage** If true, explicitly treat the content as CJKLanguage (`.Summary` and `.WordCount` can work properly in CJKLanguage) -* **weight** Used for sorting -* **markup** *(Experimental)* Specify `"rst"` for reStructuredText (requires - `rst2html`) or `"md"` (default) for Markdown -* **slug** appears as tail of the url. It can be used to change the part of the url that is based on the filename. -* **url** The full path to the content from the web root. It makes no assumptions about the path of the content file. It also ignores any language prefixes of the multilingual feature. - -*If neither `slug` or `url` is present, the filename will be used.* - -## Configure Blackfriday rendering - -It's possible to set some options for Markdown rendering in the page's front matter as an override to the site wide configuration. - -See [Configuration]({{< ref "overview/configuration.md#configure-blackfriday-rendering" >}}) for more. - diff --git a/docs/content/content/markdown-extras.md b/docs/content/content/markdown-extras.md deleted file mode 100644 index 7673c53da..000000000 --- a/docs/content/content/markdown-extras.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -aliases: -- /doc/supported-formats/ -lastmod: 2016-07-22 -date: 2016-07-22 -menu: - main: - parent: content -prev: /content/summaries -next: /content/multilingual -title: Markdown Extras -weight: 66 -toc: false ---- - -Hugo provides some convenient markdown extensions. - -## Task lists - -Hugo supports GitHub styled task lists (TODO lists) for the Blackfriday renderer (md-files). See [Blackfriday config](/overview/configuration/#configure-blackfriday-rendering) for how to turn it off. - -Example: - -```markdown -- [ ] a task list item -- [ ] list syntax required -- [ ] incomplete -- [x] completed -``` - -Renders as: - -- [ ] a task list item -- [ ] list syntax required -- [ ] incomplete -- [x] completed - - -And produces this HTML: - -```html - -<ul class="task-list"> -<li><input type="checkbox" disabled="" class="task-list-item"> a task list item</li> -<li><input type="checkbox" disabled="" class="task-list-item"> list syntax required</li> -<li><input type="checkbox" disabled="" class="task-list-item"> incomplete</li> -<li><input type="checkbox" checked="" disabled="" class="task-list-item"> completed</li> -</ul> -``` diff --git a/docs/content/content/multilingual.md b/docs/content/content/multilingual.md deleted file mode 100644 index 5e09bc539..000000000 --- a/docs/content/content/multilingual.md +++ /dev/null @@ -1,232 +0,0 @@ ---- -date: 2016-01-02T21:21:00Z -menu: - main: - parent: content -prev: /content/markdown-extras -next: /content/example -title: Multilingual Mode -weight: 68 -toc: true ---- -Hugo supports multiple languages side-by-side (added in `Hugo 0.17`). Define the available languages in a `Languages` section in your top-level `config.toml` (or equivalent). - -Example: - -``` -DefaultContentLanguage = "en" -copyright = "Everything is mine" - -[params.navigation] -help = "Help" - -[Languages] -[Languages.en] -title = "My blog" -weight = 1 -[Languages.en.params] -linkedin = "english-link" - -[Languages.fr] -copyright = "Tout est à moi" -title = "Mon blog" -weight = 2 -[Languages.fr.params] -linkedin = "lien-francais" -[Languages.fr.navigation] -help = "Aide" - -``` - -Anything not defined in a `[Languages]` block will fall back to the global -value for that key (like `copyright` for the English (`en`) language in this example). - -With the config above, all content, sitemap, RSS feeds, paginations -and taxonomy pages will be rendered below `/` in English (your default content language), and below `/fr` in French. - -When working with params in frontmatter pages, omit the `params` in the key for the translation. - -If you want all of the languages to be put below their respective language code, enable `defaultContentLanguageInSubdir: true` in your configuration. - -Only the obvious non-global options can be overridden per language. Examples of global options are `BaseURL`, `BuildDrafts`, etc. - -Taxonomies and Blackfriday configuration can also be set per language, example: - -``` -[Taxonomies] -tag = "tags" - -[blackfriday] -angledQuotes = true -hrefTargetBlank = true - -[Languages] -[Languages.en] -weight = 1 -title = "English" -[Languages.en.blackfriday] -angledQuotes = false - -[Languages.fr] -weight = 2 -title = "Français" -[Languages.fr.Taxonomies] -plaque = "plaques" -``` - - -### Translating your content - -Translated articles are identified by the name of the content file. - -Example of translated articles: - -1. `/content/about.en.md` -2. `/content/about.fr.md` - -You can also have: - -1. `/content/about.md` -2. `/content/about.fr.md` - -In which case the config variable `defaultContentLanguage` will be used to affect the default language `about.md`. This way, you can -slowly start to translate your current content without having to rename everything. - -If left unspecified, the value for `defaultContentLanguage` defaults to `en`. - -By having the same _base file name_, the content pieces are linked together as translated pieces. - -If you need distinct URLs per language you can set the slug in the non-default language file. Just define the custom slug for the french translation in your `/content/about.fr.md` file: - -``` ---- -slug: "a-propos" ---- -``` - -You will get both `/about/` and `/a-propos/` URLs in your build, properly linked as translated pieces. - -### Link to translated content - -To create a list of links to translated content, use a template similar to this: - -``` -{{ if .IsTranslated }} -<h4>{{ i18n "translations" }}</h4> -<ul> - {{ range .Translations }} - <li> - <a href="{{ .Permalink }}">{{ .Lang }}: {{ .Title }}{{ if .IsPage }} ({{ i18n "wordCount" . }}){{ end }}</a> - </li> - {{ end}} -</ul> -{{ end }} -``` -The above can be put in a `partial` and included in any template, be it for a content page or the home page. It will not print anything if there are no translations for a given page, or if it is -- in the case of the home page, section listing etc. -- a site with only one language. - -The above also uses the `i18n` func, see [Translation of strings](#translation-of-strings). - -### Translation of strings - -Hugo uses [go-i18n](https://github.com/nicksnyder/go-i18n) to support string translations. Follow the link to find tools to manage your translation workflows. - -Translations are collected from the `themes/[name]/i18n/` folder (built into the theme), as well as translations present in `i18n/` at the root of your project. In the `i18n`, the translations will be merged and take precedence over what is in the theme folder. Language files should be named according to RFC 5646 with names such as `en-US.toml`, `fr.toml`, etc. - -From within your templates, use the `i18n` function like this: - -``` -{{ i18n "home" }} -``` - -This uses a definition like this one in `i18n/en-US.toml`: - -``` -[home] -other = "Home" -``` - -Often you will want to use to the page variables in the translations strings. To do that, pass on the "." context when calling `i18n`: - -``` -{{ i18n "wordCount" . }} -``` - -This uses a definition like this one in `i18n/en-US.toml`: - -``` -[wordCount] -other = "This article has {{ .WordCount }} words." -``` -An example of singular and plural form: - -``` -[readingTime] -one = "One minute read" -other = "{{.Count}} minutes read" -``` -And then in the template: - -``` -{{ i18n "readingTime" .ReadingTime }} -``` -To track down missing translation strings, run Hugo with the `--i18n-warnings` flag: - -```bash - hugo --i18n-warnings | grep i18n -i18n|MISSING_TRANSLATION|en|wordCount -``` - -### Menus - -You can define your menus for each language independently. The [creation of a menu]({{< relref "extras/menus.md" >}}) works analogous to earlier versions of Hugo, except that they have to be defined in their language-specific block in the configuration file: - -```toml -defaultContentLanguage = "en" - -[languages.en] -weight = 0 -languageName = "English" - -[[languages.en.menu.main]] -url = "/" -name = "Home" -weight = 0 - - -[languages.de] -weight = 10 -languageName = "Deutsch" - -[[languages.de.menu.main]] -url = "/" -name = "Startseite" -weight = 0 -``` - -The rendering of the main navigation works as usual. `.Site.Menus` will just contain the menu of the current language. Pay attention to the generation of the menu links. `absLangURL` takes care that you link to the correct locale of your website. Otherwise, both menu entries would link to the English version because it's the default content language that resides in the root directory. - -```html -<ul> - {{- $currentPage := . -}} - {{ range .Site.Menus.main -}} - <li class="{{ if $currentPage.IsMenuCurrent "main" . }}active{{ end }}"> - <a href="{{ .URL | absLangURL }}">{{ .Name }}</a> - </li> - {{- end }} -</ul> - -``` - -### Missing translations - -If a string does not have a translation for the current language, Hugo will use the value from the default language. If no default value is set, an empty string will be shown. - -While translating a Hugo site, it can be handy to have a visual indicator of missing translations. The `EnableMissingTranslationPlaceholders` config option will flag all untranslated strings with the placeholder `[i18n] identifier`, where `identifier` is the id of the missing translation. - -**Remember: Hugo will generate your website with these placeholders. It might not be suited for production environments.** - -### Multilingual Themes support - -To support Multilingual mode in your themes, some considerations must be taken for the URLs in the templates. If there are more than one language, URLs must either come from the built-in `.Permalink` or `.URL`, be constructed with `relLangURL` or `absLangURL` template funcs -- or prefixed with `{{.LanguagePrefix }}`. - -If there are more than one language defined, the`LanguagePrefix` variable will equal `"/en"` (or whatever your `CurrentLanguage` is). If not enabled, it will be an empty string, so it is harmless for single-language sites. diff --git a/docs/content/content/ordering.md b/docs/content/content/ordering.md deleted file mode 100644 index d0933a608..000000000 --- a/docs/content/content/ordering.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -lastmod: 2015-12-23 -date: 2014-03-06 -linktitle: Ordering -menu: - main: - parent: content -next: /content/summaries -prev: /content/archetypes -title: Ordering Content -weight: 60 ---- - -Hugo provides you with all the flexibility you need to organize how your content is ordered. - -By default, content is ordered by weight, then by date with the most -recent date first, but alternative sorting (by `title` and `linktitle`) is -also available. The order the content would appear is specified in -the [list template](/templates/list/). - -_Both the `date` and `weight` fields are optional._ - -Unweighted pages appear at the end of the list. If no weights are provided (or -if weights are the same), `date` will be used to sort. If neither is provided, -content will be ordered based on how it's read off the disk, and no order is -guaranteed. - -## Assigning weight to content - -```toml -+++ -weight = 4 -title = "Three" -date = "2012-04-06" -+++ -Front Matter with Ordered Pages 3 -``` - -## Ordering Content Within Taxonomies - -Please see the [Taxonomy Ordering Documentation](/taxonomies/ordering/). diff --git a/docs/content/content/organization.md b/docs/content/content/organization.md deleted file mode 100644 index bd83fbf04..000000000 --- a/docs/content/content/organization.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -aliases: -- /doc/organization/ -lastmod: 2015-09-27 -date: 2013-07-01 -linktitle: Organization -menu: - main: - parent: content -next: /content/supported-formats -prev: /overview/source-directory -title: Content Organization -weight: 10 -toc: true ---- - -Hugo uses files (see [supported formats](/content/supported-formats/)) with headers commonly called the *front matter*. Hugo -respects the organization that you provide for your content to minimize any -extra configuration, though this can be overridden by additional configuration -in the front matter. - -## Organization - -In Hugo, the content should be arranged in the same way they are intended for -the rendered website. Without any additional configuration, the following will -just work. Hugo supports content nested at any level. The top level is special -in Hugo and is used as the [section](/content/sections/). - - . - └── content - └── about - | └── _index.md // <- http://1.com/about/ - ├── post - | ├── firstpost.md // <- http://1.com/post/firstpost/ - | ├── happy - | | └── ness.md // <- http://1.com/post/happy/ness/ - | └── secondpost.md // <- http://1.com/post/secondpost/ - └── quote - ├── first.md // <- http://1.com/quote/first/ - └── second.md // <- http://1.com/quote/second/ - -**Here's the same organization run with `hugo --uglyURLs`** - - . - └── content - └── about - | └── _index.md // <- http://1.com/about/ - ├── post - | ├── firstpost.md // <- http://1.com/post/firstpost.html - | ├── happy - | | └── ness.md // <- http://1.com/post/happy/ness.html - | └── secondpost.md // <- http://1.com/post/secondpost.html - └── quote - ├── first.md // <- http://1.com/quote/first.html - └── second.md // <- http://1.com/quote/second.html - -## Destinations - -Hugo believes that you organize your content with a purpose. The same structure -that works to organize your source content is used to organize the rendered -site. As displayed above, the organization of the source content will be -mirrored in the destination. - -Notice that the first level `about/` page URL was created using a directory -named "about" with a single `_index.md` file inside. Find out more about `_index.md` specifically in [content for the homepage and other list pages](https://gohugo.io/overview/source-directory#content-for-home-page-and-other-list-pages). - -There are times when one would need more control over their content. In these -cases, there are a variety of things that can be specified in the front matter -to determine the destination of a specific piece of content. - -The following items are defined in order; latter items in the list will override -earlier settings. - -### filename -This isn't in the front matter, but is the actual name of the file minus the -extension. This will be the name of the file in the destination. - -### slug -Defined in the front matter, the `slug` can take the place of the filename for the -destination. - -### filepath -The actual path to the file on disk. Destination will create the destination -with the same path. Includes [section](/content/sections/). - -### section -`section` is determined by its location on disk and *cannot* be specified in the front matter. See [section](/content/sections/). - -### type -`type` is also determined by its location on disk but, unlike `section`, it *can* be specified in the front matter. See [type](/content/types/). - -### path -`path` can be provided in the front matter. This will replace the actual -path to the file on disk. Destination will create the destination with the same -path. Includes [section](/content/sections/). - -### url -A complete URL can be provided. This will override all the above as it pertains -to the end destination. This must be the path from the baseURL (starting with a "/"). -When a `url` is provided, it will be used exactly. Using `url` will ignore the -`--uglyURLs` setting. - - -## Path breakdown in Hugo - -### Content - - . path slug - . ⊢-------^----⊣ ⊢------^-------⊣ - content/extras/indexes/category-example/index.html - - - . section slug - . ⊢--^--⊣ ⊢------^-------⊣ - content/extras/indexes/category-example/index.html - - - . section slug - . ⊢--^--⊣⊢--^--⊣ - content/extras/indexes/index.html - -### Destination - - - permalink - ⊢--------------^-------------⊣ - http://spf13.com/projects/hugo - - - baseURL section slug - ⊢-----^--------⊣ ⊢--^---⊣ ⊢-^⊣ - http://spf13.com/projects/hugo - - - baseURL section slug - ⊢-----^--------⊣ ⊢--^--⊣ ⊢--^--⊣ - http://spf13.com/extras/indexes/example - - - baseURL path slug - ⊢-----^--------⊣ ⊢------^-----⊣ ⊢--^--⊣ - http://spf13.com/extras/indexes/example - - - baseURL url - ⊢-----^--------⊣ ⊢-----^-----⊣ - http://spf13.com/projects/hugo - - - baseURL url - ⊢-----^--------⊣ ⊢--------^-----------⊣ - http://spf13.com/extras/indexes/example - - - -**section** = which type the content is by default - -* based on content location -* front matter overrides - -**slug** = name.ext or name/ - -* based on content-name.md -* front matter overrides - -**path** = section + path to file excluding slug - -* based on path to content location - - -**url** = relative URL - -* defined in front matter -* overrides all the above - diff --git a/docs/content/content/sections.md b/docs/content/content/sections.md deleted file mode 100644 index c603c0872..000000000 --- a/docs/content/content/sections.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -lastmod: 2015-12-23 -date: 2013-07-01 -menu: - main: - parent: content -next: /content/types -notoc: true -prev: /content/front-matter -title: Sections -weight: 30 ---- - -Hugo believes that you organize your content with a purpose. The same structure -that works to organize your source content is used to organize the rendered -site (see [Organization](/content/organization/)). Following this pattern Hugo -uses the top level of your content organization as **the Section**. - -The following example site uses two sections, "post" and "quote". - -{{< nohighlight >}}. -└── content - ├── post - | ├── firstpost.md // <- http://1.com/post/firstpost/ - | ├── happy - | | └── ness.md // <- http://1.com/post/happy/ness/ - | └── secondpost.md // <- http://1.com/post/secondpost/ - └── quote - ├── first.md // <- http://1.com/quote/first/ - └── second.md // <- http://1.com/quote/second/ -{{< /nohighlight >}} - -## Section Lists - -Hugo will automatically create pages for each section root that list all -of the content in that section. See [List Templates](/templates/list/) -for details on customizing the way they appear. - -Section pages can also have a content file and frontmatter, see [Source Organization]({{< relref "overview/source-directory.md#content-for-home-page-and-other-list-pages" >}}). - -## Sections and Types - -By default everything created within a section will use the content type -that matches the section name. - -Section defined in the front matter have the same impact. - -To change the type of a given piece of content, simply define the type -in the front matter. - -If a layout for a given type hasn't been provided, a default type template will -be used instead provided it exists. - - diff --git a/docs/content/content/summaries.md b/docs/content/content/summaries.md deleted file mode 100644 index 1f65d431d..000000000 --- a/docs/content/content/summaries.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -lastmod: 2015-01-27 -date: 2013-07-01 -menu: - main: - parent: content -notoc: true -prev: /content/ordering -next: /content/markdown-extras -title: Summaries -weight: 65 ---- - -With the use of the `.Summary` [page variable](/templates/variables/), Hugo can generate summaries of content to show snippets in summary views. The summary view snippets are automatically generated by Hugo. Where a piece of content is split for the content summary depends on whether the split is Hugo-defined or user-defined. - -Content summaries may also provide links to the original content, usually in the form of a "Read More..." link, with the help of the `.RelPermalink` or `.Permalink` variable, as well as the `.Truncated` boolean variable to determine whether such "Read More..." link is necessary. - -## Hugo-defined: automatic summary split - -By default, Hugo automatically takes the first 70 words of your content as its summary and stores it into the `.Summary` variable, which you may use in your templates. - -* Pros: Automatic, no additional work on your part. -* Cons: All HTML tags are stripped from the summary, and the first 70 words, whether they belong to a heading or to different paragraphs, are all lumped into one paragraph. Some people like it, but some people don't. - -## User-defined: manual summary split: - -Alternatively, you may add the <code><!--more--></code> summary divider[^1] (for org content, use <code># more</code>) where you want to split the article. Content prior to the summary divider will be used as that content's summary, and stored into the `.Summary` variable with all HTML formatting intact. - -[^1]: The **summary divider** is also called "more tag", "excerpt separator", etc. in other literature. - -* Pros: Freedom, precision, and improved rendering. All formatting is preserved. -* Cons: Need to remember to type <code><!--more--></code> (or <code># more</code> for org content) in your content file. :-) - -Be careful to enter <code><!--more--></code> (or <code># more</code> for org content) exactly, i.e. all lowercase with no whitespace, otherwise it would be treated as regular comment and ignored. - -If there is nothing but spaces and newlines after the summary divider then `.Truncated` will be false. - -## Showing Summaries - -You can show content summaries with the following code. You could do this, for example, on a [list](/templates/list/) page. - - {{ range first 10 .Data.Pages }} - <div class="summary"> - <h4><a href="{{ .RelPermalink }}">{{ .Title }}</a></h4> - {{ .Summary }} - </div> - {{ if .Truncated }} - <div class="read-more-link"> - <a href="{{ .RelPermalink }}">Read More…</a> - </div> - {{ end }} - {{ end }} - -Note how the `.Truncated` boolean valuable may be used to hide the "Read More..." link when the content is not truncated, i.e. when the summary contains the entire article. diff --git a/docs/content/content/supported-formats.md b/docs/content/content/supported-formats.md deleted file mode 100644 index 3fc905d6d..000000000 --- a/docs/content/content/supported-formats.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -aliases: -- /doc/supported-formats/ -lastmod: 2015-08-01 -date: 2015-08-01 -menu: - main: - parent: content -next: /content/front-matter -prev: /content/organization -title: Supported Formats -weight: 15 -toc: true ---- - - Since 0.14, Hugo has defined a new concept called _external helpers_. It means that you can write your content using Asciidoc[tor], reStructuredText or Org-Mode. If you have files with associated extensions ([details](https://github.com/gohugoio/hugo/blob/77c60a3440806067109347d04eb5368b65ea0fe8/helpers/general.go#L65)), then Hugo will call external commands to generate the content (the exception being Org-Mode content, which is parsed natively). - - This means that you will have to install the associated tool on your machine to be able to use those formats. - - For example, for Asciidoc files, Hugo will try to call __asciidoctor__ or __asciidoc__ command. - - To use those formats, just use the standard extension and the front matter exactly as you would do with natively supported _.md_ files. - - Notes: - - * as these are external commands, generation performance for that content will heavily depend on the performance of those external tools. - * this feature is still in early stage, hence feedback is even more welcome. diff --git a/docs/content/content/types.md b/docs/content/content/types.md deleted file mode 100644 index 277294881..000000000 --- a/docs/content/content/types.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -lastmod: 2015-09-28 -date: 2013-07-01 -linktitle: Types -menu: - main: - parent: content -next: /content/archetypes -prev: /content/sections -title: Content Types -weight: 40 -toc: true ---- - -Hugo has full support for different types of content. A content type can have a -unique set of meta data, template and can be automatically created by the `hugo new` -command through using content [archetypes](/content/archetypes/). - -A good example of when multiple types are needed is to look at [Tumblr](https://www.tumblr.com/). A piece -of content could be a photo, quote or post, each with different meta data and -rendered differently. - -## Assigning a content type - -Hugo assumes that your site will be organized into [sections](/content/sections/) -and each section will use the corresponding type. If you are taking advantage of -this, then each new piece of content you place into a section will automatically -inherit the type. - -Alternatively, you can set the type in the meta data under the key "`type`". - - -## Creating new content of a specific type - -Hugo has the ability to create a new content file and populate the front matter -with the data set corresponding to that type. Hugo does this by utilizing -[archetypes](/content/archetypes/). - -To create a new piece of content, use: - - hugo new relative/path/to/content.md - -For example, if I wanted to create a new post inside the post section, I would type: - - hugo new post/my-newest-post.md - - -## Defining a content type - -Creating a new content type is easy in Hugo. You simply provide the templates and archetype -that the new type will use. You only need to define the templates, archetypes and/or views -unique to that content type. Hugo will fall back to using the general templates and default archetype -whenever a specific file is not present. - -*Remember, all of the following are optional:* - -### Create Type Directory -Create a directory with the name of the type in `/layouts`. Type is always singular. *E.g. `/layouts/post`*. - -### Create single template -Create a file called `single.html` inside your directory. *E.g. `/layouts/post/single.html`*. - -### Create list template -Create a file called `post.html` inside the section lists template directory, `/layouts/section`. *E.g. `/layouts/section/post.html`*. - -### Create views -Many sites support rendering content in a few different ways, for -instance, a single page view and a summary view to be used when -displaying a [list of contents on a single page](/templates/list). -Hugo makes no assumptions here about how you want to display your -content, and will support as many different views of a content type -as your site requires. All that is required for these additional -views is that a template exists in each `/layouts/TYPE` directory -with the same name. - -### Create a corresponding archetype - -Create a file called <code><em>type</em>.md</code> in the `/archetypes` directory. *E.g. `/archetypes/post.md`*. - -More details about archetypes can be found at the [archetypes docs](/content/archetypes/). diff --git a/docs/content/content/using-index-md.md b/docs/content/content/using-index-md.md deleted file mode 100644 index 1f1298f67..000000000 --- a/docs/content/content/using-index-md.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -aliases: -- /doc/using-index-md/ -lastmod: 2017-02-22 -date: 2017-02-22 -linktitle: Using _index.md -menu: - main: - parent: content -prev: /content/example -next: /themes/overview -notoc: true -title: Using _index.md -weight: 70 ---- -# \_index.md and 'Everything is a Page' - -As of version v0.18 Hugo now treats '[everything as a page](http://bepsays.com/en/2016/12/19/hugo-018/)'. This allows you to add content and frontmatter to any page - including List pages like [Sections](/content/sections/), [Taxonomies](/taxonomies/overview/), [Taxonomy Terms pages](/templates/terms/) and even to potential 'special case' pages like the [Home page](/templates/homepage/). - -In order to take advantage of this behaviour you need to do a few things. - -1. Create an \_index.md file that contains the frontmatter and content you would like to apply. - -2. Place the \_index.md file in the correct place in the directory structure. - -3. Ensure that the respective template is configured to display `{{ .Content }}` if you wish for the content of the \_index.md file to be rendered on the respective page. - -## How \_index.md pages work - -Before continuing it's important to know that this page must reference certain templates to describe how the \_index.md page will be rendered. Hugo has a multitude of possible templates that can be used and placed in various places (think theme templates for instance). For simplicity/brevity the default/top level template location will be used to refer to the entire range of places the template can be placed. - -If this is confusing or you are unfamiliar with Hugo's template hierarchy, visit the various template pages listed below. You may need to find the 'active' template responsible for any particular page on your own site by going through the template hierarchy and matching it to your particular setup/theme you are using. - -- [Home page template](/templates/homepage/) -- [Content List templates](/templates/list/) -- [Single Content templates](/templates/content/) -- [Taxonomy Terms templates](/templates/terms/) - -Now that you've got a handle on templates lets recap some Hugo basics to understand how to use an \_index.md file with a List page. - -1. Sections and Taxonomies are 'List' pages, NOT single pages. -2. List pages are rendered using the template hierarchy found in the [Content - List Template](/templates/list/) docs. -3. The Home page, though technically a List page, can have [its own template](/templates/homepage/) at layouts/index.html rather than \_default/list.html. Many themes exploit this behaviour so you are likely to encounter this specific use case. -4. Taxonomy terms pages are 'lists of metadata' not lists of content, so [have their own templates](/templates/terms/). - -Let's put all this information together: - -> **\_index.md files used in List pages, Terms pages or the Home page are NOT rendered as single pages or with Single Content templates.** - -> **All pages, including List pages, can have frontmatter and frontmatter can have markdown content - meaning \_index.md files are the way to _provide_ frontmatter and content to the respective List/Terms/Home page.** - -Here are a couple of examples to make it clearer... - -| \_index.md location | Page affected | Rendered by | -| ------------------- | ------------ | ----------- | -| /content/post/\_index.md | site.com/post/ | /layouts/section/post.html | -| /content/categories/hugo/\_index.md | site.com/categories/hugo/ | /layouts/taxonomy/hugo.html | - -## Why \_index.md files are used - -With a Single page such as a post it's possible to add the frontmatter and content directly into the .md page itself. With List/Terms/Home pages this is not possible so \_index.md files can be used to provide that frontmatter/content to them. - -## How to display content from \_index.md files - -From the information above it should follow that content within an \_index.md file won't be rendered in its own Single Page, instead it'll be made available to the respective List/Terms/Home page. - -To **_actually render that content_** you need to ensure that the relevant template responsible for rendering the List/Terms/Home page contains (at least) `{{ .Content }}`. - -This is the way to actually display the content within the \_index.md file on the List/Terms/Home page. - -A very simple/naive example of this would be: - -```html -{{ partial "header.html" . }} - <main> - {{ .Content }} - {{ range .Paginator.Pages }} - {{ partial "summary.html" . }} - {{ end }} - {{ partial "pagination.html" . }} - </main> -{{ partial "sidebar.html" . }} -{{ partial "footer.html" . }} -``` - -You can see `{{ .Content }}` just after the `<main>` element. For this particular example, the content of the \_index.md file will show before the main list of summaries. - -## Where to organise an \_index.md file - -To add content and frontmatter to the home page, a section, a taxonomy or a taxonomy terms listing, add a markdown file with the base name \_index on the relevant place on the file system. - -```bash -└── content - ├── _index.md - ├── categories - │ ├── _index.md - │ └── photo - │ └── _index.md - ├── post - │ ├── _index.md - │ └── firstpost.md - └── tags - ├── _index.md - └── hugo - └── _index.md -``` - -In the above example \_index.md pages have been added to each section/taxonomy. - -An \_index.md file has also been added in the top level 'content' directory. - -### Where to place \_index.md for the Home page - -Hugo themes are designed to use the 'content' directory as the root of the website, so adding an \_index.md file here (like has been done in the example above) is how you would add frontmatter/content to the home page. - - - - diff --git a/docs/content/extras/aliases.md b/docs/content/extras/aliases.md deleted file mode 100644 index 00f014ca0..000000000 --- a/docs/content/extras/aliases.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -aliases: -- /doc/redirects/ -- /doc/alias/ -- /doc/aliases/ -lastmod: 2015-12-23 -date: 2013-07-09 -menu: - main: - parent: extras -next: /extras/analytics -prev: /taxonomies/methods -title: Aliases ---- - -For people migrating existing published content to Hugo, there's a good chance you need a mechanism to handle redirecting old URLs. - -Luckily, redirects can be handled easily with _aliases_ in Hugo. - -## Example - -Given a post on your current Hugo site, with a path of: - -``content/posts/my-awesome-blog-post.md`` - -... you create an "aliases" section in the frontmatter of your post, and add previous paths to that. - -### TOML frontmatter - -```toml -+++ - ... -aliases = [ - "/posts/my-original-url/", - "/2010/01/01/even-earlier-url.html" -] - ... -+++ -``` - -### YAML frontmatter - -```yaml ---- - ... -aliases: - - /posts/my-original-url/ - - /2010/01/01/even-earlier-url.html - ... ---- -``` - -Now when you visit any of the locations specified in aliases, _assuming the same site domain_, you'll be redirected to the page they are specified on. - -## Important Behaviors - -1. *Hugo makes no assumptions about aliases. They also don't change based -on your UglyURLs setting. You need to provide absolute path to your webroot -and the complete filename or directory.* - -2. *Aliases are rendered prior to any content and will be overwritten by -any content with the same location.* - -## Multilingual example - -On [multilingual sites]({{< relref "content/multilingual.md" >}}), each translation of a post can have unique aliases. To use the same alias across multiple languages, prefix it with the language code. - -In `/posts/my-new-post.es.md`: - -```yaml ---- -aliases: - - /es/posts/my-original-post/ ---- -``` - -## How Hugo Aliases Work - -When aliases are specified, Hugo creates a physical folder structure to match the alias entry, and, an html file specifying the canonical URL for the page, and a redirect target. - -Assuming a baseURL of `mysite.tld`, the contents of the html file will look something like: - -```html -<!DOCTYPE html> -<html> - <head> - <title>http://mysite.tld/posts/my-original-url</title> - <link rel="canonical" href="http://mysite.tld/posts/my-original-url"/> - <meta http-equiv="content-type" content="text/html; charset=utf-8"/> - <meta http-equiv="refresh" content="0; url=http://mysite.tld/posts/my-original-url"/> - </head> -</html> -``` - -The `http-equiv="refresh"` line is what performs the redirect, in 0 seconds in this case. - -## Customizing - -You may customize this alias page by creating an alias.html template in the -layouts folder of your site. In this case, the data passed to the template is - -* Permalink - the link to the page being aliased -* Page - the Page data for the page being aliased diff --git a/docs/content/extras/analytics.md b/docs/content/extras/analytics.md deleted file mode 100644 index 31f44c7bf..000000000 --- a/docs/content/extras/analytics.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -date: 2016-02-06 -linktitle: Analytics -menu: - main: - parent: extras -next: /extras/builders -prev: /extras/aliases -title: Analytics in Hugo ---- - -Hugo ships with prebuilt internal templates for Google Analytics tracking, including both synchronous and asynchronous tracking codes. - -## Configuring Google Analytics - -Provide your tracking id in your configuration file, e.g. config.yaml. - - googleAnalytics = "UA-123-45" - -## Example - -Include the internal template in your templates like so: - - {{ template "_internal/google_analytics.html" . }} - -For async include the async template: - - {{ template "_internal/google_analytics_async.html" . }} diff --git a/docs/content/extras/builders.md b/docs/content/extras/builders.md deleted file mode 100644 index 707eff306..000000000 --- a/docs/content/extras/builders.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -lastmod: 2015-12-24 -date: 2014-05-26 -linktitle: Builders -menu: - main: - parent: extras -next: /extras/comments -prev: /extras/analytics -title: Hugo Builders ---- - -Hugo provides the functionality to quickly get a site, theme or page -started. - - -## New Site - -Want to get a site built quickly? - -{{< nohighlight >}}$ hugo new site <i>path/to/site</i> -{{< /nohighlight >}} - -Hugo will create all the needed directories and files to get started -quickly. - -Hugo will only touch the files and create the directories (in the right -places), [configuration](/overview/configuration/) and content are up to -you... but luckily we have builders for content (see below). - -## New Theme - -Want to design a new theme? - - $ hugo new theme THEME_NAME - -Run from your working directory, this will create a new theme with all -the needed files in your themes directory. Hugo will provide you with a -license and theme.toml file with most of the work done for you. - -Follow the [Theme Creation Guide](/themes/creation/) once the builder is -done. - -## New Content - -You will use this builder the most of all. Every time you want to create -a new piece of content, the content builder will get you started right. - -Leveraging [content archetypes](/content/archetypes/) the content builder -will not only insert the current date and appropriate metadata, but it -will pre-populate values based on the content type. - - $ hugo new relative/path/to/content - -This assumes it is being run from your working directory and the content -path starts from your content directory. Now, Hugo watches your content directory by default and rebuilds your entire website if any change occurs. diff --git a/docs/content/extras/comments.md b/docs/content/extras/comments.md deleted file mode 100644 index a2ac5d1bb..000000000 --- a/docs/content/extras/comments.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -lastmod: 2015-08-04 -date: 2014-05-26 -linktitle: Comments -menu: - main: - parent: extras -next: /extras/crossreferences -prev: /extras/builders -title: Comments in Hugo ---- - -As Hugo is a static site generator, the content produced is static and doesn’t interact with the users. The most common interaction people ask for is comment capability. - -Hugo ships with support for [Disqus](https://disqus.com/), a third-party service that provides comment and community capabilities to website via JavaScript. - -Your theme may already support Disqus, but even it if doesn’t, it is easy to add. - -# Disqus Support - -## Adding Disqus to a template - -Hugo comes with all the code you would need to include load Disqus. Simply include the following line where you want your comments to appear: - - {{ template "_internal/disqus.html" . }} - -## Configuring Disqus - -That template requires you to set a single value in your site config file, e.g. config.yaml. - - disqusShortname = "XYW" - -Additionally, you can optionally set the following in the front matter -for a given piece of content: - - * **disqus_identifier** - * **disqus_title** - * **disqus_url** - -## Conditional Loading of Disqus Comments - -Users have noticed that enabling Disqus comments when running the Hugo web server on localhost causes the creation of unwanted discussions on the associated Disqus account. In order to prevent this, a slightly tweaked partial template is required. So, rather than using the built-in `"_internal/disqus.html"` template referenced above, create a template in your `partials` folder that looks like this: - -```html -<div id="disqus_thread"></div> -<script type="text/javascript"> - -(function() { - // Don't ever inject Disqus on localhost--it creates unwanted - // discussions from 'localhost:1313' on your Disqus account... - if (window.location.hostname == "localhost") - return; - - var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true; - var disqus_shortname = '{{ .Site.DisqusShortname }}'; - dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js'; - (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq); -})(); -</script> -<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript> -<a href="http://disqus.com/" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a> -``` - -Notice that there is a simple `if` statement that detects when you are running on localhost and skips the initialization of the Disqus comment injection. - -Now, reference the partial template from your page template: - - {{ partial "disqus.html" . }} - - -# Alternatives - -A few alternatives exist to [Disqus](https://disqus.com/): - -* [txtpen](https://txtpen.com) -* [Discourse](http://www.discourse.org) -* [IntenseDebate](http://intensedebate.com/) -* [Livefyre](http://www.adobe.com/marketing-cloud/enterprise-content-management/ugc-content-platform.html) -* [Muut](http://muut.com/) -* [多说](http://duoshuo.com/) ([Duoshuo](http://duoshuo.com/), popular in China) -* [isso](http://posativ.org/isso/) (Self-hosted, Python) -* [Kaiju](https://github.com/spf13/kaiju) - -## Kaiju - -[Kaiju](https://github.com/spf13/kaiju) is an open-source project started by [spf13](http://spf13.com/) (Hugo’s author) to bring easy and fast real time discussions to the web. - -Written using Go, Socket.io and MongoDB, it is very fast and easy to deploy. - -It is in early development but shows promise. If you have interest, please help by contributing whether via a pull request, an issue or even just a tweet. Everything helps. - -## txtpen - -[txtpen](https://txtpen.com) adds highlighting an in-line commenting similar to Medium to your Hugo blog. - -## Discourse - -Additionally, you may recognize [Discourse](http://www.discourse.org) as the system that powers the [Hugo Discussion Forum](http://discuss.gohugo.io). - diff --git a/docs/content/extras/crossreferences.md b/docs/content/extras/crossreferences.md deleted file mode 100644 index 9f3e7ef23..000000000 --- a/docs/content/extras/crossreferences.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -lastmod: 2015-12-23 -date: 2014-11-25 -menu: - main: - parent: extras -next: /extras/robots-txt -prev: /extras/comments -title: Cross-References -toc: true ---- - -Hugo makes it easy to link documents together with the `ref` and `relref` shortcodes. These shortcodes are also used to safely provide links to headings inside of your content, whether across documents or within a document. The only difference between `ref` and `relref` is whether the resulting URL is absolute (`http://1.com/about/`) or relative (`/about/`). - -## Using `ref` and `relref` - -```django -{{</* ref "document" */>}} -{{</* ref "#anchor" */>}} -{{</* ref "document#anchor" */>}} -{{</* relref "document" */>}} -{{</* relref "#anchor" */>}} -{{</* relref "document#anchor" */>}} -``` - -The single parameter to `ref` is a string with a content _document name_ (`about.md`), an in-document _anchor_ (`#who`), or both (`about.md#who`). - -### Document Names - -The _document name_ is the name of a document including the format extension; this may be just the filename, or the relative path from the `content/` directory. With a document `content/blog/post.md`, either format will produce the same result. - - {{</* relref "blog/post.md" */>}} ⇒ `/blog/post/` - {{</* relref "post.md" */>}} ⇒ `/blog/post/` - -If you have multiple sections with the same filename, you should only use the relative path format, because the behaviour is _undefined_. So, if I also have a document `link/post.md`, the output of `ref` is unknown for `post.md`. - - {{</* relref "blog/post.md" */>}} ⇒ `/blog/post/` - {{</* relref "post.md" */>}} ⇒ `/blog/post/` (maybe) - {{</* relref "post.md" */>}} ⇒ `/link/post/` (maybe) - {{</* relref "link/post.md" */>}} ⇒ `/link/post/` - -A relative document name must *not* begin with a slash (`/`). - - {{</* relref "/blog/post.md" */>}} ⇒ `""` - -### Anchors - -When an _anchor_ is provided by itself, the current page’s unique identifier will be appended; when an _anchor_ is provided with a document name, the found page's unique identifier will be appended. - - {{</* relref "#who" */>}} ⇒ `#who:9decaf7` - {{</* relref "blog/post.md#who" */>}} ⇒ `/blog/post/#who:badcafe` - -More information about document unique identifiers and headings can be found [below]({{< ref "#hugo-heading-anchors" >}}). - -### Examples - -* `{{</* ref "blog/post.md" */>}}` ⇒ `http://1.com/blog/post/` -* `{{</* ref "post.md#tldr" */>}}` ⇒ `http://1.com/blog/post/#tldr:caffebad` -* `{{</* relref "post.md" */>}}` ⇒ `/blog/post/` -* `{{</* relref "blog/post.md#tldr" */>}}` ⇒ `/blog/post/#tldr:caffebad` -* `{{</* ref "#tldr" */>}}` ⇒ `#tldr:badcaffe` -* `{{</* relref "#tldr" */>}}` ⇒ `#tldr:badcaffe` - -## Hugo Heading Anchors - -When using Markdown document types, Hugo generates heading anchors automatically. The generated anchor for this section is `hugo-heading-anchors`. Because the heading anchors are generated automatically, Hugo takes some effort to ensure that heading anchors are unique both inside a document and across the entire site. - -Ensuring heading uniqueness across the site is accomplished with a unique identifier for each document based on its path. Unless a document is renamed or moved between sections *in the filesystem*, the unique identifier for the document will not change: `blog/post.md` will always have a unique identifier of `81df004c333b392d34a49fd3a91ba720`. - -`ref` and `relref` were added so you can make these reference links without having to know the document’s unique identifier. (The links in document tables of contents are automatically up-to-date with this value.) - - {{</* relref "extras/crossreferences.md#hugo-heading-anchors" */>}} - /extras/crossreferences/#hugo-heading-anchors:77cd9ea530577debf4ce0f28c8dca242 - -> What follows is a deeper discussion of *why* and *how* Hugo generates heading anchors. It is not necessary to know this to use `ref` and `relref`, but it may be useful in understanding how some anchors may not match your expectations. - -### How to Generate a Heading Anchor - -Convert the text of the heading to lowercase. - - Hugo: A Fast & Modern Static Web Engine - hugo: a fast & modern static web engine - -Replace anything that isn't an ASCII letter (`a-z`) or number (`0-9`) with a dash (`-`). - - hugo: a fast & modern static web engine - hugo--a-fast---modern-static-web-engine - -Get rid of extra dashes. - - hugo--a-fast---modern-static-web-engine - hugo-a-fast-modern-static-web-engine - -You have just converting the text of a heading to a suitable anchor. If your document has unique heading text, all of the anchors will be unique, too. - -#### Specifying Heading Anchors - -You can also tell Hugo to use a particular heading anchor. - - # Hugo: A Fast & Modern Static Web Engine {#hugo-main} - -Hugo will use `hugo-main` as the heading anchor. - -### What About Duplicate Heading Anchors? - -The technique outlined above works well enough, but some documents have headings with identical text, like the [shortcodes](/extras/shortcodes/) page—there are three headings with the text "Example". You can specify heading anchors manually: - - ### Example {#example-1} - ### Example {#example-2} - ### Example {#example-3} - -It’s easy to forget to do that all the time, and Hugo is smart enough to do it for you. It just adds `-x` to the end of each heading it has already seen. - -* `### Example` ⇒ `example` -* `### Example` ⇒ `example-1` -* `### Example` ⇒ `example-2` - -Sometimes it's a little harder, but Hugo can recover from those, too, by adding more suffixes: - -* `# Heading` ⇒ `heading` -* `# Heading 1` ⇒ `heading-1` -* `# Heading` ⇒ `heading-1-1` -* `# Heading` ⇒ `heading-1-2` -* `# Heading 1` ⇒ `heading-2` - -This can even affect specified heading anchors that come after a generated heading anchor. - -* `# My Heading` ⇒ `my-heading` -* `# My Heading {#my-heading}` ⇒ `my-heading-1` - -> This particular collision and override is unfortunate, but unavoidable because Hugo processes each heading for collision detection as it sees it during conversion. - -This technique works well for documents rendered on individual pages, like blog posts. What about on Hugo list pages? - -### Unique Heading Anchors in Lists - -Hugo converts each document from Markdown independently. it doesn’t know that `blog/post.md` has an "Example" heading that will collide with the "Example" heading in `blog/post2.md`. Even if it did know this, the addition of `blog/post3.md` should not cause the anchors for the headings in the other blog posts to change. - -Enter the document’s unique identifier. To prevent this sort of collision on -list pages, Hugo always appends the document's to a generated heading anchor. -So, the "Example" heading in `blog/post.md` actually turns into -`#example:81df004…`, and the "Example" heading in `blog/post2.md` actually -turns into `#example:8cf1599…`. All you have to know is the heading anchor that -was generated, not the document identifier; `ref` and `relref` take care of the -rest for you. - - <a href='{{</* relref "blog/post.md#example" */>}}'>Post Example</a> - <a href='/blog/post.md#81df004…'>Post Example</a> - - [Post Two Example]({{</* relref "blog/post2.md#example" */>}}) - <a href='/blog/post2.md#8cf1599…'>Post Two Example</a> - -Now you know. diff --git a/docs/content/extras/datadrivencontent.md b/docs/content/extras/datadrivencontent.md deleted file mode 100644 index e5c6c9130..000000000 --- a/docs/content/extras/datadrivencontent.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -aliases: -- /doc/datadrivencontent/ -lastmod: 2016-03-03 -date: 2015-02-14 -menu: - main: - parent: extras -next: /extras/gitinfo -prev: /extras/datafiles -title: Data-driven Content -toc: true ---- - -Data-driven content with a static site generator? Yes, it is possible! - -In addition to the [data files](/extras/datafiles/) feature, we have also -implemented the feature "Data-driven Content", which lets you load -any [JSON](http://www.json.org/) or -[CSV](http://en.wikipedia.org/wiki/Comma-separated_values) file -from nearly any resource. - -"Data-driven Content" currently consists of two functions, `getJSON` -and `getCSV`, which are available in **all template files**. - -## Implementation details - -### Calling the functions with an URL - -In any HTML template or Markdown document, call the functions like this: - - {{ $dataJ := getJSON "url" }} - {{ $dataC := getCSV "separator" "url" }} - -or, if you use a prefix or postfix for the URL, the functions -accept [variadic arguments](http://en.wikipedia.org/wiki/Variadic_function): - - {{ $dataJ := getJSON "url prefix" "arg1" "arg2" "arg n" }} - {{ $dataC := getCSV "separator" "url prefix" "arg1" "arg2" "arg n" }} - -The separator for `getCSV` must be put in the first position and can only -be one character long. - -All passed arguments will be joined to the final URL; for example: - - {{ $urlPre := "https://api.github.com" }} - {{ $gistJ := getJSON $urlPre "/users/GITHUB_USERNAME/gists" }} - -will resolve internally to: - - {{ $gistJ := getJSON "https://api.github.com/users/GITHUB_USERNAME/gists" }} - -Finally, you can range over an array. This example will output the -first 5 gists for a GitHub user: - - <ul> - {{ $urlPre := "https://api.github.com" }} - {{ $gistJ := getJSON $urlPre "/users/GITHUB_USERNAME/gists" }} - {{ range first 5 $gistJ }} - {{ if .public }} - <li><a href="{{ .html_url }}" target="_blank">{{ .description }}</a></li> - {{ end }} - {{ end }} - </ul> - - -### Example for CSV files - -For `getCSV`, the one-character long separator must be placed in the -first position followed by the URL. - - <table> - <thead> - <tr> - <th>Name</th> - <th>Position</th> - <th>Salary</th> - </tr> - </thead> - <tbody> - {{ $url := "http://a-big-corp.com/finance/employee-salaries.csv" }} - {{ $sep := "," }} - {{ range $i, $r := getCSV $sep $url }} - <tr> - <td>{{ index $r 0 }}</td> - <td>{{ index $r 1 }}</td> - <td>{{ index $r 2 }}</td> - </tr> - {{ end }} - </tbody> - </table> - -The expression `{{index $r number}}` must be used to output the nth-column from -the current row. - -### Caching of URLs - -Each downloaded URL will be cached in the default folder `$TMPDIR/hugo_cache/`. -The variable `$TMPDIR` will be resolved to your system-dependent -temporary directory. - -With the command-line flag `--cacheDir`, you can specify any folder on -your system as a caching directory. - -You can also set `cacheDir` in the main configuration file. - -If you don't like caching at all, you can fully disable caching with the -command line flag `--ignoreCache`. - -### Authentication when using REST URLs - -Currently, you can only use those authentication methods that can -be put into an URL. [OAuth](http://en.wikipedia.org/wiki/OAuth) or -other authentication methods are not implemented. - -### Loading local files - -To load local files with the two functions `getJSON` and `getCSV`, the -source files must reside within Hugo's working directory. The file -extension does not matter but the content does. - -It applies the same output logic as in the topic: *Calling the functions with an URL*. - -## LiveReload - -There is no chance to trigger a [LiveReload](/extras/livereload/) when -the content of an URL changes. However, when a local JSON/CSV file changes, -then a LiveReload will be triggered of course. Symlinks are not supported. - -**URLs and LiveReload**: If you change any local file and the LiveReload -is triggered, Hugo will either read the URL content from the cache or, if -you have disabled the cache, Hugo will re-download the content. -This can create huge traffic and you may also reach API limits quickly. - -As downloading of content takes a while, Hugo stops processing -your Markdown files until the content has been downloaded. - -## Examples - -- Photo gallery JSON powered: [https://github.com/pcdummy/hugo-lightslider-example](https://github.com/pcdummy/hugo-lightslider-example) -- GitHub Starred Repositories [in a posts](https://github.com/SchumacherFM/blog-cs/blob/master/content%2Fposts%2Fgithub-starred.md) with the related [short code](https://github.com/SchumacherFM/blog-cs/blob/master/layouts%2Fshortcodes%2FghStarred.html). -- More? Please tell us! diff --git a/docs/content/extras/datafiles.md b/docs/content/extras/datafiles.md deleted file mode 100644 index dc7e8059c..000000000 --- a/docs/content/extras/datafiles.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -aliases: -- /doc/datafiles/ -lastmod: 2015-08-04 -date: 2015-01-22 -menu: - main: - parent: extras -next: /extras/datadrivencontent -prev: /extras/robots-txt -title: Data Files ---- - -In addition to the [built-in variables](/templates/variables/) available from Hugo, you can specify your own custom data that can be accessed via templates or shortcodes. - -Hugo supports loading data from [YAML](http://yaml.org/), [JSON](http://www.json.org/), and [TOML](https://github.com/toml-lang/toml) files located in the `data` directory. - -**It even works with [LiveReload](/extras/livereload/).** - -Data Files can also be used in [themes](/themes/overview/), but note: If the same `key` is used in both the main data folder and in the theme's data folder, the main one will win. So, for theme authors, for theme specific data items that shouldn't be overridden, it can be wise to prefix the folder structure with a namespace, e.g. `mytheme/data/mytheme/somekey/...`. To check if any such duplicate exists, run hugo with the `-v` flag, e.g. `hugo -v`. - -## The Data Folder - -The `data` folder is where you can store additional data for Hugo to use when generating your site. Data files aren't used to generate standalone pages - rather they're meant to supplement the content files. This feature can extend the content in case your frontmatter would grow immensely. Or perhaps you want to show a larger dataset in a template (see example below). In both cases it's a good idea to outsource the data in their own file. - -These files must be YAML, JSON or TOML files (using either the `.yml`, `.yaml`, `.json` or `toml` extension) and the data will be accessible as a `map` in `.Site.Data`. - -**The keys in this map will be a dot chained set of _path_, _filename_ and _key_ in file (if applicable).** - -This is best explained with an example: - -## Example: Jaco Pastorius' Solo Discography - -[Jaco Pastorius](http://en.wikipedia.org/wiki/Jaco_Pastorius_discography) was a great bass player, but his solo discography is short enough to use as an example. [John Patitucci](http://en.wikipedia.org/wiki/John_Patitucci) is another bass giant. - -The example below is a bit constructed, but it illustrates the flexibility of Data Files. It uses TOML as file format. - -Given the files: - -* `data/jazz/bass/jacopastorius.toml` -* `data/jazz/bass/johnpatitucci.toml` - -`jacopastorius.toml` contains the content below, `johnpatitucci.toml` contains a similar list: - -``` -discography = [ -"1974 – Modern American Music … Period! The Criteria Sessions", -"1974 – Jaco", -"1976 - Jaco Pastorius", -"1981 - Word of Mouth", -"1981 - The Birthday Concert (released in 1995)", -"1982 - Twins I & II (released in 1999)", -"1983 - Invitation", -"1986 - Broadway Blues (released in 1998)", -"1986 - Honestly Solo Live (released in 1990)", -"1986 - Live In Italy (released in 1991)", -"1986 - Heavy'n Jazz (released in 1992)", -"1991 - Live In New York City, Volumes 1-7.", -"1999 - Rare Collection (compilation)", -"2003 - Punk Jazz: The Jaco Pastorius Anthology (compilation)", -"2007 - The Essential Jaco Pastorius (compilation)" -] -``` - -The list of bass players can be accessed via `.Site.Data.jazz.bass`, a single bass player by adding the filename without the suffix, e.g. `.Site.Data.jazz.bass.jacopastorius`. - -You can now render the list of recordings for all the bass players in a template: - -``` -{{ range $.Site.Data.jazz.bass }} - {{ partial "artist.html" . }} -{{ end }} -``` - -And then in `partial/artist.html`: - -``` -<ul> -{{ range .discography }} - <li>{{ . }}</li> -{{ end }} -</ul> -``` - -Discover a new favourite bass player? Just add another TOML-file. - -## Example: Accessing named values in a Data File - -Assuming you have the following YAML structure to your `User0123.yml` Data File located directly in `data/` - -``` -Name: User0123 -"Short Description": "He is a **jolly good** fellow." -Achievements: - - "Can create a Key, Value list from Data File" - - "Learns Hugo" - - "Reads documentation" -``` - -To render the `Short Description` in your `layout` File following code is required. - -``` -<div>Short Description of {{.Site.Data.User0123.Name}}: <p>{{ index .Site.Data.User0123 "Short Description" | markdownify }}</p></div> -``` - -Note the use of the `markdownify` template function. This will send the description through the Blackfriday Markdown rendering engine. diff --git a/docs/content/extras/gitinfo.md b/docs/content/extras/gitinfo.md deleted file mode 100644 index d29641bcb..000000000 --- a/docs/content/extras/gitinfo.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -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 - -The Git integrations should be fairly performant, but it does add some time to the build, which depends somewhat on the Git history size. - diff --git a/docs/content/extras/highlighting.md b/docs/content/extras/highlighting.md deleted file mode 100644 index 601373deb..000000000 --- a/docs/content/extras/highlighting.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -aliases: -- /extras/highlight/ -lastmod: 2015-10-27 -date: 2013-07-01 -menu: - main: - parent: extras -next: /extras/toc -prev: /extras/shortcodes -title: Syntax Highlighting -toc: true ---- - -Hugo provides the ability for you to highlight source code in _two different ways_ — either pre-processed server side from your content, or to defer the processing to the client side, using a JavaScript library. - -**The advantage of server side** is that it doesn’t depend on a JavaScript library and consequently works very well when read from an RSS feed. - -**The advantage of client side** is that it doesn’t cost anything when building your site and some of the highlighting scripts available cover more languages than Pygments does. - -## Server-side - -For the pre-processed approach, highlighting is performed by an external Python-based program called [Pygments](http://pygments.org/) and is triggered via an embedded Hugo shortcode (see example below). If Pygments is absent from the path, it will silently simply pass the content along unhighlighted. - -### Pygments - -If you have never worked with Pygments before, here is a brief primer: - -+ Install Python from [python.org](https://www.python.org/downloads/). Version 2.7.x is already sufficient. -+ Run `pip install Pygments` in order to install Pygments. Once installed, Pygments gives you a command `pygmentize`. Make sure it sits in your PATH, otherwise Hugo cannot find it. - -On Debian and Ubuntu systems, you may also install Pygments by running `sudo apt-get install python3-pygments`. - -Hugo gives you two options that you can set with the variable `pygmentsuseclasses` (default `false`) in `config.toml` (or `config.yaml`). - -1. Color-codes for highlighting keywords are directly inserted if `pygmentsuseclasses = false` (default). See in the example below. The color-codes depend on your choice of the `pygmentsstyle` (default `"monokai"`). You can explore the different color styles on [pygments.org](http://pygments.org/) after inserting some example code. -2. If you choose `pygmentsuseclasses = true`, Hugo includes class names in your code instead of color-codes. For class-names to be meaningful, you need to include a `.css`-file in your website representing your color-scheme. You can either generate this `.css`-files according to this [description](http://pygments.org/docs/cmdline/) or download the standard ones from the [GitHub pygments-css repository](https://github.com/richleland/pygments-css). - -### Usage - -Highlighting is carried out via the in-built shortcode `highlight`. `highlight` takes exactly one required parameter of language, and requires a closing shortcode. Note that `highlight` is _not_ used for client-side javascript highlighting. - -### Example - -``` -{{</* highlight html */>}} -<section id="main"> - <div> - <h1 id="title">{{ .Title }}</h1> - {{ range .Data.Pages }} - {{ .Render "summary"}} - {{ end }} - </div> -</section> -{{</* /highlight */>}} -``` - -### Example Output - -``` -<span style="color: #f92672"><section</span> <span style="color: #a6e22e">id=</span><span style="color: #e6db74">"main"</span><span style="color: #f92672">></span> - <span style="color: #f92672"><div></span> - <span style="color: #f92672"><h1</span> <span style="color: #a6e22e">id=</span><span style="color: #e6db74">"title"</span><span style="color: #f92672">></span>{{ .Title }}<span style="color: #f92672"></h1></span> - {{ range .Data.Pages }} - {{ .Render "summary"}} - {{ end }} - <span style="color: #f92672"></div></span> -<span style="color: #f92672"></section></span> -``` - -### Options - -Options to control highlighting can be added as a quoted, comma separated key-value list as the second argument in the shortcode. The example below will highlight as language `go` with inline line numbers, with line number 2 and 3 highlighted. - -``` -{{</* highlight go "linenos=inline,hl_lines=2 3" */>}} -var a string -var b string -var c string -var d string -{{</* / highlight */>}} -``` - -Supported keywords: `style`, `encoding`, `noclasses`, `hl_lines`, `linenos`. Note that `style` and `noclasses` will override the similar setting in the global config. - -The keywords are the same you would using with Pygments from the command line, see the [Pygments doc](http://pygments.org/docs/) for more info. - -### Code fences - -It is also possible to add syntax highlighting with GitHub flavoured code fences. To enable this, set the `PygmentsCodeFences` to `true` in Hugo's configuration file. - -```` -``` html -<section id="main"> - <div> - <h1 id="title">{{ .Title }}</h1> - {{ range .Data.Pages }} - {{ .Render "summary"}} - {{ end }} - </div> -</section> -``` -```` - -### Disclaimers - - * Pygments is relatively slow and _causes a performance hit when building your site_, but Hugo has been designed to cache the results to disk. - * The caching can be turned off by setting the `--ignoreCache` flag to `true`. - * Languages available depends on your Pygments installation. - -## Client-side - -Alternatively, code highlighting can be done in client-side JavaScript. - -Client-side syntax highlighting is very simple to add. You'll need to pick -a library and a corresponding theme. Some popular libraries are: - -- [Highlight.js] -- [Prism] -- [Rainbow] -- [Syntax Highlighter] -- [Google Prettify] - -### Highlight.js example - -This example uses the popular [Highlight.js] library, hosted by [Yandex], a popular Russian search engine. - -In your `./layouts/partials/` (or `./layouts/chrome/`) folder, depending on your specific theme, there will be a snippet that will be included in every generated HTML page, such as `header.html` or `header.includes.html`. Simply add the css and js to initialize [Highlight.js]: - -~~~ -<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.6.0/styles/default.min.css"> -<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.6.0/highlight.min.js"></script> -<script>hljs.initHighlightingOnLoad();</script> -~~~ - -### Prism example - -Prism is another popular highlighter library, used on some major sites. Similar to Highlight.js, you simply load `prism.css` in your `<head>` via whatever Hugo partial template is creating that part of your pages, like so: - -```html -... -<link href="/css/prism.css" rel="stylesheet" /> -... -``` - -... and add `prism.js` near the bottom of your `<body>` tag, again in whatever Hugo partial template is appropriate for your site or theme. - -```html -... -<script src="/js/prism.js"></script> -... -</body> -``` - -In this example, the local paths indicate that your own copy of these files are being added to the site, typically under `./static/`. - -### Using Client-side highlighting - -To use client-side highlighting, most of these javascript libraries expect your code to be wrapped in semantically correct `<code>` tags, with the language expressed in a class attribute on the `<code>` tag, such as `class="language-abc"`, where the `abc` is the code the highlighter script uses to represent that language. - -The script would be looking for classes like `language-go`, `language-html`, or `language-css`. If you look at the page's source, it would be marked up like so: - -~~~html -<pre> -<code class="language-css"> -body { - font-family: "Noto Sans", sans-serif; -} -</code> -</pre> -~~~ - -The markup in your content pages (e.g. `my-css-tutorial.md`) needs to look like the following, with the name of the language to be highlighted entered directly after the first "fence", in a fenced code block: - -<pre><code class="language-css">~~~css -body { - font-family: "Noto Sans", sans-serif; -} -~~~</code></pre> - -When passed through the highlighter script, it would yield something like this output when viewed on your rendered page: - -~~~css -body { - font-family: "Noto Sans", sans-serif; -} -~~~ - -Please see individual libraries' documentation for how to implement each of the JavaScript-based libraries. - -[Prism]: http://prismjs.com -[Highlight.js]: http://highlightjs.org/ -[Rainbow]: http://craig.is/making/rainbows -[Syntax Highlighter]: http://alexgorbatchev.com/SyntaxHighlighter/ -[Google Prettify]: https://github.com/google/code-prettify -[Yandex]: http://yandex.ru/ - diff --git a/docs/content/extras/livereload.md b/docs/content/extras/livereload.md deleted file mode 100644 index cb4047636..000000000 --- a/docs/content/extras/livereload.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -lastmod: 2016-08-09 -date: 2014-05-26 -menu: - main: - parent: extras -next: /extras/menus -prev: /extras/gitinfo -title: LiveReload ---- - -Hugo may not be the first static site generator to utilize LiveReload -technology, but it’s the first to do it right. - -The combination of Hugo’s insane build speed and LiveReload make -crafting your content pure joy. Virtually instantly after you hit save -your rebuilt content will appear in your browser. - -## Using LiveReload - -Hugo comes with LiveReload built in. There are no additional packages to -install. A common way to use Hugo while developing a site is to have -Hugo run a server and watch for changes: - -{{< nohighlight >}}$ hugo server -{{< /nohighlight >}} - -This will run a full functioning web server while simultaneously -watching your file system for additions, deletions or changes within -your: - - * static files - * content - * data files - * layouts - * current theme - * configuration files - -Whenever anything changes, Hugo will rebuild the site while continuing to serve -the content. As soon as the build is finished, it will tell the -browser and silently reload the page. Because most Hugo builds are so -fast they are barely noticeable, you merely need to glance at your open -browser and you will see the change, already there. - -This means that keeping the site open on a second monitor (or another -half of your current monitor) allows you to see exactly what your -content looks like, without even leaving your text editor. - -## Disabling Watch - -If for some reason you don't want the Hugo server's watch functionality, -just do: - -{{< nohighlight >}}$ hugo server --watch=false -{{< /nohighlight >}} - -## Disabling LiveReload - -LiveReload works by injecting JavaScript into the pages Hugo generates, -which creates a connection from the browser web socket client to the -Hugo web socket server. - -Awesome for development, but not something you would want to do in -production. Since many people use `hugo server` in production to -instantly display any updated content, we’ve made it easy to disable the -LiveReload functionality: - -{{< nohighlight >}}$ hugo server --disableLiveReload -{{< /nohighlight >}} - -## Notes - -You must have a closing `</body>` tag for LiveReload to work. -Hugo injects the LiveReload `<script>` before this tag. diff --git a/docs/content/extras/localfiles.md b/docs/content/extras/localfiles.md deleted file mode 100644 index 28b611870..000000000 --- a/docs/content/extras/localfiles.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -aliases: -- /doc/localfiles/ -lastmod: 2016-09-12 -date: 2015-06-12 -menu: - main: - parent: extras -next: /extras/urls -notoc: true -prev: /extras/toc -title: Traversing Local Files ---- -## Traversing Local Files - -Using Hugo's function `readDir`, -you can traverse your web site's files on your server. -## Using _readDir_ - -The `readDir` function returns an array -of [`os.FileInfo`](https://golang.org/pkg/os/#FileInfo). -It takes a single, string argument: a path. -This path can be to any directory of your web site -(as found on your server's filesystem). - -Whether the path is absolute or relative makes no difference, -because—at least for `readDir`—the root of your web site (typically `./public/`) -in effect becomes both: - -1. The filesystem root; and -1. The current working directory. - -## New Shortcode - -So, let's create a new shortcode using `readDir`: - -**layouts/shortcodes/directoryindex.html** -```html -{{< readfile "layouts/shortcodes/directoryindex.html" >}} -``` -For the files in any given directory, -this shortcode usefully lists their basenames and sizes, -while providing links to them. - -Already—actually—this shortcode -has been included in this very web site. -So, let's list some of its CSS files. -(If you click on their names, you can reveal the contents.) -{{< directoryindex path="/static/css" pathURL="/css" >}} -<br /> -This is the call that rendered the above output: -```html -{{</* directoryindex path="/static/css" pathURL="/css" */>}} -``` -By the way, -regarding the pathURL argument, the initial slash `/` is important. -Otherwise, it becomes relative to the current web page. diff --git a/docs/content/extras/menus.md b/docs/content/extras/menus.md deleted file mode 100644 index 84b59e831..000000000 --- a/docs/content/extras/menus.md +++ /dev/null @@ -1,393 +0,0 @@ ---- -lastmod: 2015-08-04 -date: 2014-05-14T02:36:37Z -toc: true -menu: - main: - parent: extras -next: /extras/pagination -prev: /extras/livereload -title: Menus ---- - -Hugo has a simple yet powerful menu system that permits content to be -placed in menus with a good degree of control without a lot of work. - - -*TIP:* If all you want is a simple menu for your sections, see [Section Menu for "the Lazy Blogger"]({{< relref "#section-menu-for-the-lazy-blogger" >}}). - -Some of the features of Hugo Menus: - -* Place content in one or many menus -* Handle nested menus with unlimited depth -* Create menu entries without being attached to any content -* Distinguish active element (and active branch) - -## What is a menu? - -A menu is a named array of menu entries accessible on the site under -`.Site.Menus` by name. For example, if I have a menu called `main`, I would -access it via `.Site.Menus.main`. - -If you make use of the [multilingual feature]({{< relref "content/multilingual.md#menus">}}) you can define menus language independent. - -A menu entry has the following properties: - -* `URL string` -* `Name string` -* `Menu string` -* `Identifier string` -* `Pre template.HTML` -* `Post template.HTML` -* `Weight int` -* `Parent string` -* `Children Menu` - -And the following functions: - -* `HasChildren() bool` - -Additionally, the `Page` object has two functions, which can be used when rendering menus: - -* `IsMenuCurrent (menu string, menuEntry *MenuEntry ) bool` -* `HasMenuCurrent** (menu string, menuEntry *MenuEntry) bool` - -See [Menu Functions](#menu-functions) for explanations of these functions, and [Rendering Nested Menus](#rendering-nested-menus) for an example of their use. - -## Adding content to menus - -Hugo supports a couple of different methods of adding a piece of content -to the front matter. - -### Simple - -If all you need to do is add an entry to a menu, the simple form works -well. - -**A single menu:** - - --- - menu: "main" - --- - -**Multiple menus:** - - --- - menu: ["main", "footer"] - --- - - -### Advanced - -If more control is required, then the advanced approach gives you the -control you want. All of the menu entry properties listed above are -available. - - --- - menu: - main: - parent: 'extras' - weight: 20 - --- - - -## Adding (non-content) entries to a menu - -You can also add entries to menus that aren’t attached to a piece of -content. This takes place in the sitewide [config file](/overview/configuration/). - -Here’s an example `config.toml`: - - [[menu.main]] - name = "about hugo" - pre = "<i class='fa fa-heart'></i>" - weight = -110 - identifier = "about" - url = "/about/" - [[menu.main]] - name = "getting started" - pre = "<i class='fa fa-road'></i>" - weight = -100 - url = "/getting-started/" - -And the equivalent example `config.yaml`: - - --- - menu: - main: - - Name: "about hugo" - Pre: "<i class='fa fa-heart'></i>" - Weight: -110 - Identifier: "about" - URL: "/about/" - - Name: "getting started" - Pre: "<i class='fa fa-road'></i>" - Weight: -100 - URL: "/getting-started/" - --- - - -**NOTE:** The URLs must be relative to the context root. If the `baseURL` is `http://example.com/mysite/`, then the URLs in the menu must not include the context root `mysite`. Using an absolute URL will overide the baseURL. If the `URL` is `http://subdomain.example.com/`, the output will be `http://subdomain.example.com`. - -## Nesting - -All nesting of content is done via the `parent` field. - -The parent of an entry should be the identifier of another entry. -Identifier should be unique (within a menu). - -The following order is used to determine an Identifier: - -> Name > LinkTitle > Title. - -This means that the title will be used unless -linktitle is present, etc. In practice Name and Identifier are never -displayed and only used to structure relationships. - -In this example, the top level of the menu is defined in the config file -and all content entries are attached to one of these entries via the -`parent` field. - -## Rendering menus - -Hugo makes no assumptions about how your rendered HTML will be -structured. Instead, it provides all of the functions you will need to be -able to build your menu however you want. - - -The following is an example: - - <!--sidebar start--> - <aside> - <div id="sidebar" class="nav-collapse"> - <!-- sidebar menu start--> - <ul class="sidebar-menu"> - {{ $currentPage := . }} - {{ range .Site.Menus.main }} - {{ if .HasChildren }} - - <li class="sub-menu{{if $currentPage.HasMenuCurrent "main" . }} active{{end}}"> - <a href="javascript:;" class=""> - {{ .Pre }} - <span>{{ .Name }}</span> - <span class="menu-arrow arrow_carrot-right"></span> - </a> - <ul class="sub"> - {{ range .Children }} - <li{{if $currentPage.IsMenuCurrent "main" . }} class="active"{{end}}><a href="{{.URL}}"> {{ .Name }} </a> </li> - {{ end }} - </ul> - {{else}} - <li> - <a href="{{.URL}}"> - {{ .Pre }} - <span>{{ .Name }}</span> - </a> - {{end}} - </li> - {{end}} - <li> <a href="https://github.com/gohugoio/hugo/issues" target="blank">Questions and Issues</a> </li> - <li> <a href="#" target="blank">Edit this Page</a> </li> - </ul> - <!-- sidebar menu end--> - </div> - </aside> - <!--sidebar end--> - -> **Note**: use the `absLangURL` or `relLangURL` if your theme makes use of the [multilingual feature]({{< relref "content/multilingual.md" >}}). In contrast to `absURL` and `relURL` it adds the correct language prefix to the url. [Read more]({{< relref "templates/functions.md#urls" >}}). - -## Section Menu for "the Lazy Blogger" - -To enable this menu, add this to your site config, i.e. `config.toml`: - -``` -SectionPagesMenu = "main" -``` - -The menu name can be anything, but take a note of what it is. - -This will create a menu with all the sections as menu items and all the sections' pages as "shadow-members". The _shadow_ implies that the pages isn't represented by a menu-item themselves, but this enables you to create a top-level menu like this: - -``` - <nav class="sidebar-nav"> - {{ $currentPage := . }} - {{ range .Site.Menus.main }} - <a class="sidebar-nav-item{{if or ($currentPage.IsMenuCurrent "main" .) ($currentPage.HasMenuCurrent "main" .) }} active{{end}}" href="{{.URL}}">{{ .Name }}</a> - {{ end }} - </nav> - -``` - -In the above, the menu item is marked as active if on the current section's list page or on a page in that section. - -The above is all that's needed. But if you want custom menu items, e.g. changing weight or name, you can define them manually in the site config, i.e. `config.toml`: - -``` - [[menu.main]] - name = "This is the blog section" - weight = -110 - identifier = "blog" - url = "/blog/" - -``` - -**Note** that the `identifier` must match the section name. - - - - -## Menu Functions - -Suppose you have the menu structure shown below. - -``` - [menu.main] - │ - ├───colour - │ │ - │ ├───warm - │ │ ├───orange - │ │ ├───red - │ │ └───yellow - │ │ - │ └───cool - │ ├───blue - │ ├───green - │ └───purple - │ - └───tool - ├───hammer - ├───shovel - └───saw -``` - -For each menu item, you can determine: - -* If the menu item has any children: `.HasChildren()` -* If the menu item is a parent of the page you are currently rendering: `.Page.HasMenuCurrent()` -* If the menu item **is** the page you are currently rendering: `.Page.IsMenuCurrent()` - -For example, if you are currently rendering the page `/colour/warm`, the values of `.HasChildren`, `HasMenuCurrent`, and `IsMenuCurrent` would be as shown below: - -``` - - [menu.main] | | | | - │ | | | | - ├───colour | HasMenuCurrent | | HasChildren | - │ ├───<< WARM >> | | IsMenuCurrent | HasChildren | - │ │ ├───orange | | | | - │ │ ├───red | | | | - │ │ └───yellow | | | | - │ └───cool | | | HasChildren | - │ ├───blue | | | | - │ ├───green | | | | - │ └───purple | | | | - └───tool | | | HasChildren | - ├───hammer | | | | - ├───shovel | | | | - └───saw | | | | -``` - -## Rendering nested menus - -Hugo supports nested menus with as many levels as you like. - -Nested menus can be rendered using a recursive partial template, such as the example below. - -``` -<!-- layouts/index.html, layouts/_default/single.html, ... --> -<h1>{{ .Title }}</h1> -<!-- Put this line in your main template, at the place where you want to - render the menu. --> -{{ partial "menu_include.html" . }} -``` - -``` -<!-- layouts/partials/menu_include.html --> -{{ partial "menu_recursive.html" (dict "menu" .Site.Menus.main "page" . "site" .Site) }} -``` - -``` -<!-- layouts/partials/menu_recursive.html --> -{{ $page := .page }} -{{ $site := .site }} -<ul> -{{ range .menu }} - {{ $is := $page.IsMenuCurrent "main" . }} - {{ $has := $page.HasMenuCurrent "main" . }} - {{ if .HasChildren }} - <li> - <a href="{{ .URL }}"> - {{ .Name }} - {{ if $is }}[Is]{{ end }} - {{ if $has }}[Has]{{ end }} - {{ if .HasChildren }}[Children]{{ end }} - </a> - <!-- If the menu item has children, include this partial template again (recursively) --> - {{ partial "menu_recursive.html" (dict "menu" .Children "page" $page "site" $site) }} - </li> - {{ else }} - <li> - <a href="{{ .URL }}"> - {{ .Name }} - {{ if $is }}[Is]{{ end }} - {{ if $has }}[Has]{{ end }} - {{ if .HasChildren }}[Children]{{ end }} - </a> - </li> - {{ end }} -{{ end }} -</ul> -``` - -This example code renders the words `[Is]`, `[Has]`, and `[Children]` to demonstrate how the `IsMenuCurrent()`, `HasMenuCurrent()`, and `HasChildren()` functions work. - -You can customise this example to implement features such as: - -* Highlight the current item, by applying a CSS style: - - <a href="{{ .URL }}"{{ if $is }} class="active"{{ end }}> - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -* Highlight parents of the current item, by applying a CSS style: - - <a href="{{ .URL }}"{{ if $has }} class="parent-active"{{ end }}> - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -* Only render sub-menus for parents of the current menu item, and the current menu item itself: - - {{ if or $is $has }} - {{ partial "menu_recursive.html" (dict "menu" .Children "page" $page "site" $site) }} - {{ end }} - -A working example, implementing these features, is shown below. - -``` -<!-- layouts/partials/menu_recursive.html --> -{{ $page := .page }} -{{ $site := .site }} -<ul> -<!-- Menu items sorted alphabetically by name --> -{{ range .menu.ByName }} - {{ $is := $page.IsMenuCurrent "main" . }} - {{ $has := $page.HasMenuCurrent "main" . }} - {{ if .HasChildren }} - <li> - <a href="{{ .URL }}" class="{{ if $is }} active{{ end }}{{ if $has }} parent-active{{ end }}"> - {{ .Name }} - <!-- Show a » symbol if there is a sub-menu we haven't rendered --> - {{ if not (or $is $has) }}»{{ end }} - </a> - <!-- Only render sub-menu for parent items and the current item --> - {{ if or $is $has }} - {{ partial "menu_recursive.html" (dict "menu" .Children "page" $page "site" $site) }} - {{ end }} - </li> - {{ else }} - <li> - <a href="{{ .URL }}" class="{{ if $is }}active{{end}}">{{ .Name }}</a> - </li> - {{ end }} -{{ end }} -</ul> -``` diff --git a/docs/content/extras/output-formats.md b/docs/content/extras/output-formats.md deleted file mode 100644 index 8ebc55b69..000000000 --- a/docs/content/extras/output-formats.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -aliases: -- /doc/output-formats/ -- /doc/custom-output/ -date: 2017-03-22T08:20:13+01:00 -menu: - main: - parent: extras -title: Output Formats -weight: 5 -toc: true ---- - -Hugo `0.20` introduced the powerful feature **Custom Output Formats**; Hugo isn't just that "static HTML with an added RSS feed" anymore. _Say hello_ to calendars, e-book formats, Google AMP, and JSON search indexes, to name a few. - -This page describes how to properly configure your site with the media types and output formats you need. - -## Media Types - -A [media type](https://en.wikipedia.org/wiki/Media_type) (also known as MIME type and content type) is a two-part identifier for file formats and format contents transmitted on the Internet. - -This is the full set of built-in media types in Hugo: - -{{< datatable "media" "types" "Type" "Suffix" >}} - -**Note:** - -* It is possible to add custom media types or change the defaults (if you, say, want to change the suffix to `asp` for `text/html`). -* The `Suffix` is the value that will be used for URLs and filenames for that media type in Hugo. -* The `Type` is the identifier that must be used when defining new `Output Formats` (see below). -* The full set of media types will be registered in Hugo's built-in development server to make sure they are recognized by the browser. - -To add or modify a media type, define it in a `mediaTypes` section in your site config (either for all sites or for a given language). - -Example in `config.toml`: - -```toml -[mediaTypes] -[mediaTypes."text/enriched"] -suffix = "enr" -[mediaTypes."text/html"] -suffix = "asp" -``` - -The above example adds one new media type, `text/enriched`, and changes the suffix for the built-in `text/html` media type. - -## Output Formats -Given a media type and some additional configuration, you get an `Output Format`. - -This is the full set of built-in output formats in Hugo: - -{{< datatable "output" "formats" "Name" "MediaType" "Path" "BaseName" "Rel" "Protocol" "IsPlainText" "IsHTML" "NoUgly" "NotAlternative">}} - -**Note:** - -* A page can be output in as many output formats as you want, and you can have an infinite amount of output formats defined, as long as _they resolve to a unique path on the file system_. In the table above, the best example of this is `AMP` vs. `HTML`: We have given `AMP` a value for `Path` so it doesn't overwrite the `HTML` version, i.e. we can now have both `/index.html` and `/amp/index.html`. -* The `MediaType` must match the `Type` of an already defined media type (see above). -* You can define new or redefine built-in output formats (if you, as an example, want to put `AMP` pages in a different path). - -To add or modify a media type, define it in a `outputFormats` section in your site config (either for all sites or for a given language). - -Example in `config.toml`: - -```toml -[outputFormats.MyEnrichedFormat] -mediaType = "text/enriched" -baseName = "myindex" -isPlainText = true -protocol = "bep://" -``` - -The above example is fictional, but if used for the home page on a site with `baseURL` `http://example.org`, it will produce a plain text home page with the URL `bep://example.org/myindex.enr`. - -All the available configuration options for output formats and their default values: - -Field | Description ---- | --- -**Name** | The output format identifier. This is used to define what output format(s) you want for your pages. -**MediaType**|This must match the `Type` of a defined media type. | -**Path** | Sub path to save the output files. -**BaseName** | The base filename for the list filenames (home page etc.). **Default:** _index_. -**Rel** | Can be used to create `rel` values in `link` tags. **Default:** _alternate_. -**Protocol** | Will replace the "http://" or "https://" in your `baseURL` for this output format. -**IsPlainText** | Use Go's plain text templates parser for the templates. **Default:** _false_. -**IsHTML** | Used in situations only relevant for `HTML` type of formats, page aliases being one example.| -**NoUgly** | If `uglyURLs` is enabled globally, this can be used to turn it off for a given output format. **Default:** _false_. -**NotAlternative** | Enable if it doesn't make sense to include this format in an the `.AlternativeOutputFormats` format listing on `Page`, `CSS` being one good example. Note that we use the term "alternative" and not "alternate" here, as it does not necessarily replace the other format, it is an alternative representation. **Default:** _false_. - - -## Output Formats for your pages - -A `Page` in Hugo can be rendered to multiple representations on the file system: In its default configuration all will get an `HTML` page and some of them will get an `RSS` page (home page, sections etc.). - -This can be changed by defining an `outputs` list of output formats in either the `Page` front matter or in the site configuration (either for all sites or per language). - -Example from site config in `config.toml`: - -```toml - [outputs] - home = [ "HTML", "AMP", "RSS"] - page = [ "HTML"] - ``` - Note: - - * The output definition is per `Page` `Kind`(`page`, `home`, `section`, `taxonomy`, `taxonomyTerm`). - * The names used must match the `Name` of a defined `Output Format`. - * Any `Kind` without a definition will get `HTML`. - * These can be overriden per `Page` in front matter (see below). - * When `outputs` is specified, only the formats defined in outputs will be rendered - -A `Page` with `YAML` front matter defining some output formats for that `Page`: - -```yaml ---- - date: "2016-03-19" - outputs: - - html - - amp - - json - --- - ``` - Note: - - * The names used for the output formats are case insensitive. - * The first output format in the list will act as the default. - * The default output format is used when generating links to other pages in menus, etc. - -## Link to Output Formats - - `Page` has both `.OutputFormats` (all formats including the current) and `.AlternativeOutputFormats`, the latter useful for creating a `link rel` list in your `head` section: - - ``` - {{ range .AlternativeOutputFormats -}} - <link rel="{{ .Rel }}" type="{{ .MediaType.Type }}" href="{{ .Permalink | safeURL }}"> - {{ end -}} - ``` - -Note that `.Permalink` on `RelPermalink` on `Page` will return the first output format defined for that page (usually `HTML` if nothing else is defined). - -This is how you link to a given output format: - -``` -{{ with .OutputFormats.Get "json" -}} -<a href="{{ .Permalink }}">{{ .Name }}</a> -{{- end }} -``` -From content files, you can use the `ref` or `relref` shortcodes: - -``` -[Neat]({{</* ref "blog/neat.md" "amp" */>}}) -[Who]({{</* relref "about.md#who" "amp" */>}}) -``` - -## Templates for your Output Formats - -Of course, for a new Output Format to render anything useful, we need a template for it. - -**The fundamental thing to understand about this is that we in `Hugo 0.20` now also look at Output Format´s `Name` and MediaType´s `Suffix` when we choose the templates to use to render a given `Page`.** - -And with so many possible variations, this is best explained with some examples: - - -{{< datatable "output" "layouts" "Example" "OutputFormat" "Suffix" "Template Lookup Order" >}} - -**Note:** - -* All of the above examples can use a base template, see [Blocks]({{< relref "templates/blocks.md" >}}). -* All of the above examples can also include partials. - -Hugo will now also detect the media type and output format of partials, if possible, and use that information to decide if the partial should be parsed as a plain text template or not. - -Hugo will look for the name given, so you can name it whatever you want. But if you want it treated as plain text, you should use the file suffix and, if needed, the name of the Output Format (`[partial name].[OutputFormat].[suffix])`. - -The partial below is a plain text template (Outpuf Format is `CSV`, and since this is the only output format with the suffix `csv`, we don't need to include the Output Format's `Name`): - -``` -{{ partial "mytextpartial.csv" . }} -``` - -Also note that plain text partials can currently only be included in plain text templates, and vice versa. See [this issue](https://github.com/gohugoio/hugo/issues/3273) for some background. - - - - diff --git a/docs/content/extras/pagination.md b/docs/content/extras/pagination.md deleted file mode 100644 index 1f20e7e5a..000000000 --- a/docs/content/extras/pagination.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -aliases: -- /doc/pagination/ -lastmod: 2015-07-16 -date: 2014-01-01 -menu: - main: - parent: extras -next: /extras/permalinks -prev: /extras/menus -title: Pagination ---- - -Hugo supports pagination for the home page, sections and taxonomies. It's built to be easy use, but with loads of flexibility when needed. The real power shines when you combine it with [`where`](/templates/functions/), with its SQL-like operators, `first` and others --- you can even [order the content](/templates/list/) the way you've become used to with Hugo. - -## Configuration - -Pagination can be configured in the site configuration (e.g. `config.toml`): - -* `Paginate` (default `10`) (this setting can be overridden in the template) -* `PaginatePath` (default `page`) - -Setting `Paginate` to a positive value will split the list pages for the home page, sections and taxonomies into chunks of that size. But note that the generation of the pagination pages for sections, taxonomies and home page is *lazy* --- the pages will not be created if not referenced by a `.Paginator` (see below). - -`PaginatePath` is used to adapt the `URL` to the pages in the paginator (the default setting will produce URLs on the form `/page/1/`. - -## List the pages - -**A `.Paginator` is provided to help building a pager menu. This is currently only relevant for the templates for the home page and the list pages (sections and taxonomies).** - -There are two ways to configure and use a `.Paginator`: - -1. The simplest way is just to call `.Paginator.Pages` from a template. It will contain the pages for *that page* . -2. Select a sub-set of the pages with the available template functions and ordering options, and pass the slice to `.Paginate`, e.g. `{{ range (.Paginate ( first 50 .Data.Pages.ByTitle )).Pages }}`. - -For a given **Page**, it's one of the options above. The `.Paginator` is static and cannot change once created. - -The global page size setting (`Paginate`) can be overridden by providing a positive integer as the last argument. The examples below will give five items per page: - -* `{{ range (.Paginator 5).Pages }}` -* `{{ $paginator := .Paginate (where .Data.Pages "Type" "post") 5 }}` - -It is also possible to use the `GroupBy` functions in combination with pagination: - -``` -{{ range (.Paginate (.Data.Pages.GroupByDate "2006")).PageGroups }} -``` - -## Build the navigation - -The `.Paginator` contains enough information to build a paginator interface. - -The easiest way to add this to your pages is to include the built-in template (with `Bootstrap`-compatible styles): - -``` -{{ template "_internal/pagination.html" . }} -``` - -**Note:** If you use any filters or ordering functions to create your `.Paginator` **and** you want the navigation buttons to be shown before the page listing, you must create the `.Paginator` before it's used: - -``` -{{ $paginator := .Paginate (where .Data.Pages "Type" "post") }} -{{ template "_internal/pagination.html" . }} -{{ range $paginator.Pages }} - {{ .Title }} -{{ end }} -``` - -Without the where-filter, the above is simpler: - -``` -{{ template "_internal/pagination.html" . }} -{{ range .Paginator.Pages }} - {{ .Title }} -{{ end }} -``` - -If you want to build custom navigation, you can do so using the `.Paginator` object: - -* `PageNumber`: The current page's number in the pager sequence -* `URL`: The relative URL to the current pager -* `Pages`: The pages in the current pager -* `NumberOfElements`: The number of elements on this page -* `HasPrev`: Whether there are page(s) before the current -* `Prev`: The pager for the previous page -* `HasNext`: Whether there are page(s) after the current -* `Next`: The pager for the next page -* `First`: The pager for the first page -* `Last`: The pager for the last page -* `Pagers`: A list of pagers that can be used to build a pagination menu -* `PageSize`: Size of each pager -* `TotalPages`: The number of pages in the paginator -* `TotalNumberOfElements`: The number of elements on all pages in this paginator - -## Additional information - -The pages are built on the following form (`BLANK` means no value): - -``` -[SECTION/TAXONOMY/BLANK]/index.html -[SECTION/TAXONOMY/BLANK]/page/1/index.html => redirect to [SECTION/TAXONOMY/BLANK]/index.html -[SECTION/TAXONOMY/BLANK]/page/2/index.html -.... -``` - - diff --git a/docs/content/extras/permalinks.md b/docs/content/extras/permalinks.md deleted file mode 100644 index 4249f23a4..000000000 --- a/docs/content/extras/permalinks.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -aliases: -- /doc/permalinks/ -lastmod: 2015-01-19 -date: 2013-11-18 -menu: - main: - parent: extras -next: /extras/scratch -notoc: true -prev: /extras/pagination -title: Permalinks ---- - -By default, content is laid out into the target `publishdir` (public) -namespace matching its layout within the `contentdir` hierarchy. -The `permalinks` site configuration option allows you to adjust this on a -per-section basis. -This will change where the files are written to and will change the page's -internal "canonical" location, such that template references to -`.RelPermalink` will honour the adjustments made as a result of the mappings -in this option. - -For instance, if one of your sections is called `post`, and you want to adjust -the canonical path to be hierarchical based on the year and month, then you -might use: - -```yaml -permalinks: - post: /:year/:month/:title/ -``` - -Only the content under `post/` will be so rewritten. -A file named `content/post/sample-entry` which contains a line -`date: 2013-11-18T19:20:00-05:00` might end up with the rendered page -appearing at `public/2013/11/sample-entry/index.html` and be reachable via -the URL <http://yoursite.example.com/2013/11/sample-entry/>. - -The following is a list of values that can be used in a permalink definition. -All references to time are dependent on the content's date. - - * **:year** the 4-digit year - * **:month** the 2-digit month - * **:monthname** the name of the month - * **:day** the 2-digit day - * **:weekday** the 1-digit day of the week (Sunday = 0) - * **:weekdayname** the name of the day of the week - * **:yearday** the 1- to 3-digit day of the year - * **:section** the content's section - * **:title** the content's title - * **:slug** the content's slug (or title if no slug) - * **:filename** the content's filename (without extension) - diff --git a/docs/content/extras/robots-txt.md b/docs/content/extras/robots-txt.md deleted file mode 100644 index 2e6e18ea4..000000000 --- a/docs/content/extras/robots-txt.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -lastmod: 2016-01-06 -date: 2015-12-08 -menu: - main: - parent: extras -next: /extras/datafiles -prev: /extras/crossreferences -title: Custom robots.txt ---- - -Hugo can generated a customized [robots.txt](http://www.robotstxt.org/) in the -[same way as any other templates]({{< ref "templates/go-templates.md" >}}). - -To enable it, just set `enableRobotsTXT` option to `true` in the [configuration file]({{< ref "overview/configuration.md" >}}). By default, it generates a robots.txt, which allows everything, with the following content: - -```http -User-agent: * -``` - - -Hugo will use the template `robots.txt` according to the following list in descending precedence: - -* /layouts/robots.txt -* /themes/`THEME`/layout/robots.txt - -An example of a robots.txt layout is: - -```http -User-agent: * - -{{range .Data.Pages}} -Disallow: {{.RelPermalink}}{{end}} -``` - -This template disallows and all the pages of the site creating one `Disallow` entry for each one. diff --git a/docs/content/extras/scratch.md b/docs/content/extras/scratch.md deleted file mode 100644 index ae6ea95b6..000000000 --- a/docs/content/extras/scratch.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -aliases: -- /doc/scratch/ -lastmod: 2015-08-02 -date: 2015-01-22 -menu: - main: - parent: extras -next: /extras/shortcodes -prev: /extras/permalinks -title: Scratch ---- - -`Scratch` -- a "scratchpad" for your page-scoped variables. In most cases you can do well without `Scratch`, but there are some use cases that aren't solvable with Go's templates without `Scratch`'s help, due to scoping issues. - -`Scratch` is added to both `Page` and `Shortcode` -- with following methods: - -* `Set` and `Add` takes a `key` and the `value` to add. -* `Get` returns the `value` for the `key` given. -* `SetInMap` takes a `key`, `mapKey` and `value` -* `GetSortedMapValues` returns array of values from `key` sorted by `mapKey` - -`Set` and `SetInMap` can store values of any type. - -For single values, `Add` accepts values that support Go's `+` operator. If the first `Add` for a key is an array or slice, the following adds will be appended to that list. - -The scope of the backing data is global for the given `Page` or `Shortcode`, and spans partial and shortcode includes. - -Note that `.Scratch` from a shortcode will return the shortcode's `Scratch`, which in most cases is what you want. If you want to store it in the page scroped Scratch, then use `.Page.Scratch`. - -## Sample usage - -The usage is best illustrated with some samples: - -``` -{{ $.Scratch.Add "a1" 12 }} -{{ $.Scratch.Get "a1" }} {{/* => 12 */}} -{{ $.Scratch.Add "a1" 1 }} -{{ $.Scratch.Get "a1" }} // {{/* => 13 */}} - -{{ $.Scratch.Add "a2" "AB" }} -{{ $.Scratch.Get "a2" }} {{/* => AB */}} -{{ $.Scratch.Add "a2" "CD" }} -{{ $.Scratch.Get "a2" }} {{/* => ABCD */}} - -{{ $.Scratch.Add "l1" (slice "A" "B") }} -{{ $.Scratch.Get "l1" }} {{/* => [A B] */}} -{{ $.Scratch.Add "l1" (slice "C" "D") }} -{{ $.Scratch.Get "l1" }} {{/* => [A B C D] */}} - -{{ $.Scratch.Set "v1" 123 }} -{{ $.Scratch.Get "v1" }} {{/* => 123 */}} - -{{ $.Scratch.SetInMap "a3" "b" "XX" }} -{{ $.Scratch.SetInMap "a3" "a" "AA" }} -{{ $.Scratch.SetInMap "a3" "c" "CC" }} -{{ $.Scratch.SetInMap "a3" "b" "BB" }} -{{ $.Scratch.GetSortedMapValues "a3" }} {{/* => []interface {}{"AA", "BB", "CC"} */}} -``` - -**Note:** The examples above uses the special `$` variable, which refers to the top-level node. This is the behavior you most likely want, and will help remove some confusion when using `Scratch` inside page range loops -- and you start inadvertently calling the wrong `Scratch`. But there may be use cases for `{{ .Scratch.Add "key" "some value" }}`. - - diff --git a/docs/content/extras/shortcodes.md b/docs/content/extras/shortcodes.md deleted file mode 100644 index dc4c50b37..000000000 --- a/docs/content/extras/shortcodes.md +++ /dev/null @@ -1,413 +0,0 @@ ---- -aliases: -- /doc/shortcodes/ -lastmod: 2016-02-03 -date: 2013-07-01 -menu: - main: - parent: extras -next: /extras/highlighting -prev: /extras/scratch -title: Shortcodes -toc: true ---- - -Hugo uses Markdown for its simple content format. However, there are a lot -of things that Markdown doesn’t support well. - -We are unwilling to accept being constrained by our simple format. Also -unacceptable is writing raw HTML in our Markdown every time we want to include -unsupported content such as a video. To do so is in complete opposition to the -intent of using a bare-bones format for our content and utilizing templates to -apply styling for display. - -To avoid both of these limitations, Hugo created shortcodes. - -A shortcode is a simple snippet inside a content file that Hugo will render -using a predefined template. Note that shortcodes will not work in template -files---if you need a functionality like that in a template, you most likely -want a [partial template](/templates/partials/) instead. - -Another benefit is, you can update your shortcode with any related new classes or -techniques, and upon generation, Hugo will easily merge in your changes. You -avoid a possibly complicated search and replace operation. - -## Using a shortcode - -In your content files, a shortcode can be called by using the `{{%/* name parameters -*/%}}` form. Shortcode parameters are space delimited. Parameters with spaces -can be quoted. - -The first word is always the name of the shortcode. Parameters follow the name. -Depending upon how the shortcode is defined, the parameters may be named, -positional or both (although you can't mix parameter types in a single call). -The format for named parameters models that of HTML with the format -`name="value"`. - -Some shortcodes use or require closing shortcodes. Like HTML, the opening and closing -shortcodes match (name only), the closing being prepended with a slash. - -Example of a paired shortcode: - - {{</* highlight go */>}} A bunch of code here {{</* /highlight */>}} - -The examples above use two different delimiters, the difference being the `%` and the `<` character: - -### Shortcodes with Markdown - -The `%` characters indicates that the shortcode's inner content needs further processing by the page's rendering processor (i.e. Markdown), needed to get the **bold** text in the example below: - - - {{%/* myshortcode */%}}Hello **World!**{{%/* /myshortcode */%}} - - -### Shortcodes without Markdown - -The `<` character indicates that the shortcode's inner content doesn't need any further rendering, this will typically be pure HTML: - - {{</* myshortcode */>}}<p>Hello <strong>World!</strong></p>{{</* /myshortcode */>}} - - -## Built-in Shortcodes - -Hugo ships with a set of predefined shortcodes. - -### highlight - -This shortcode will convert the source code provided into syntax highlighted -HTML. Read more on [highlighting](/extras/highlighting/). - -#### Usage - -`highlight` takes exactly one required parameter of _language_ and requires a -closing shortcode. - -#### Example - - {{</* highlight html */>}} - <section id="main"> - <div> - <h1 id="title">{{ .Title }}</h1> - {{ range .Data.Pages }} - {{ .Render "summary"}} - {{ end }} - </div> - </section> - {{</* /highlight */>}} - - -#### Example Output - - <span style="color: #f92672"><section</span> <span style="color: #a6e22e">id=</span><span style="color: #e6db74">"main"</span><span style="color: #f92672">></span> - <span style="color: #f92672"><div></span> - <span style="color: #f92672"><h1</span> <span style="color: #a6e22e">id=</span><span style="color: #e6db74">"title"</span><span style="color: #f92672">></span>{{ .Title }}<span style="color: #f92672"></h1></span> - {{ range .Data.Pages }} - {{ .Render "summary"}} - {{ end }} - <span style="color: #f92672"></div></span> - <span style="color: #f92672"></section></span> - -### figure - -`figure` is simply an extension of the image capabilities present with Markdown. -`figure` provides the ability to add captions, CSS classes, alt text, links etc. - -#### Usage - -`figure` can use the following named parameters: - - * src - * link - * title - * caption - * class - * attr (attribution) - * attrlink - * alt - -#### Example - - {{</* figure src="/media/spf13.jpg" title="Steve Francia" */>}} - -#### Example output - - <figure> - <img src="/media/spf13.jpg" /> - <figcaption> - <h4>Steve Francia</h4> - </figcaption> - </figure> - -### ref, relref - -These shortcodes will look up the pages by their relative path (e.g., -`blog/post.md`) or their logical name (`post.md`) and return the permalink -(`ref`) or relative permalink (`relref`) for the found page. - -`ref` and `relref` also make it possible to make fragmentary links that work -for the header links generated by Hugo. - -Read more on [cross-references]({{% ref "extras/crossreferences.md" %}}). - -#### Usage - -`ref` and `relref` take exactly one required parameter of _reference_. - -#### Example - - [Neat]({{</* ref "blog/neat.md" */>}}) - [Who]({{</* relref "about.md#who" */>}}) - -If the page exists in multiple [output formats]({{< relref "extras/output-formats.md" >}}), `ref` or `relref` can be used with a output format name: - - [Neat]({{</* ref "blog/neat.md" "amp" */>}}) - - -#### Example Output - -Assuming that standard Hugo pretty URLs are turned on. - - <a href="/blog/neat">Neat</a> - <a href="/about/#who:c28654c202e73453784cfd2c5ab356c0">Who</a> - -### Twitter - -You want to include a single tweet into your blog post? Everything you need is the URL of the tweet, e.g.: - -* https://twitter.com/spf13/status/666616452582129664 - -Pass the tweet's ID from the URL as parameter to the shortcode as shown below: - - {{</* tweet 666616452582129664 */>}} - -### YouTube - -This shortcode embeds a responsive video player for [YouTube](https://www.youtube.com/) videos. Only the ID of the video is required, e.g.: - -* https://www.youtube.com/watch?v=w7Ft2ymGmfc - -Copy the ID from behind `v=` and pass it to the shortcode: - - {{</* youtube w7Ft2ymGmfc */>}} - -Furthermore, you can autoplay the embedded video by setting the `autoplay` parameter to true. Remember that you can't mix named an unamed parameters. Assign the yet unamed video id to the parameter `id` like below too. - - {{</* youtube id="w7Ft2ymGmfc" autoplay="true" */>}} - - -### Vimeo - -Adding a video from [Vimeo](https://vimeo.com/) is equivalent to the YouTube shortcode above. Extract the ID from the URL, e.g.: - -* https://vimeo.com/channels/staffpicks/146022717 - -and pass it to the shortcode: - - {{</* vimeo 146022717 */>}} - -### GitHub gists - -Including code snippets with GitHub gists while writing a tutorial is common situation bloggers face. With a given URL of the gist, e.g.: - -* https://gist.github.com/spf13/7896402 - -pass the owner and the ID of the gist to the shortcode: - - {{</* gist spf13 7896402 */>}} - -If the gist contains several files and you want to quote just one of them, you can pass the filename (quoted) as an optional third argument: - - {{</* gist spf13 7896402 "img.html" */>}} - -### Speaker Deck - -To embed slides from [Speaker Deck](https://speakerdeck.com/), click on "< /> Embed" (under Share right next to the template on Speaker Deck) and copy the URL, e.g.: - - <script async class="speakerdeck-embed" data-id="4e8126e72d853c0060001f97" data-ratio="1.33333333333333" src="//speakerdeck.com/assets/embed.js"></script> - -Extract the value from the field `data-id` and pass it to the shortcode: - - {{</* speakerdeck 4e8126e72d853c0060001f97 */>}} - -### Instagram - -If you'd like to embed photo from [Instagram](https://www.instagram.com/), all you need is photo ID from the URL, e. g.: - -* https://www.instagram.com/p/BMokmydjG-M/ - -Pass it to the shortcode: - - {{</* instagram BMokmydjG-M */>}} - -Optionally, hide caption: - - {{</* instagram BMokmydjG-M hidecaption */>}} - -## Creating your own shortcodes - -To create a shortcode, place a template in the layouts/shortcodes directory. The -template name will be the name of the shortcode. - -In creating a shortcode, you can choose if the shortcode will use _positional -parameters_, or _named parameters_, or _both_. A good rule of thumb is that if a -shortcode has a single required value in the case of the `youtube` example below, -then positional works very well. For more complex layouts with optional -parameters, named parameters work best. Allowing both types of parameters is -useful for complex layouts where you want to set default values that can be -overridden. - -**Inside the template** - -To access a parameter by position, the `.Get` method can be used: - - {{ .Get 0 }} - -To access a parameter by name, the `.Get` method should be utilized: - - {{ .Get "class" }} - -`with` is great when the output depends on a parameter being set: - - {{ with .Get "class"}} class="{{.}}"{{ end }} - -`.Get` can also be used to check if a parameter has been provided. This is -most helpful when the condition depends on either one value or another... -or both: - - {{ or .Get "title" | .Get "alt" | if }} alt="{{ with .Get "alt"}}{{.}}{{else}}{{.Get "title"}}{{end}}"{{ end }} - -If a closing shortcode is used, the variable `.Inner` will be populated with all -of the content between the opening and closing shortcodes. If a closing -shortcode is required, you can check the length of `.Inner` and provide a warning -to the user. - -A shortcode with `.Inner` content can be used without the inline content, and without the closing shortcode, by using the self-closing syntax: - - {{</* innershortcode /*/>}} - -The variable `.Params` contains the list of parameters in case you need to do -more complicated things than `.Get`. It is sometimes useful to provide a -flexible shortcode that can take named or positional parameters. To meet this -need, Hugo shortcodes have a `.IsNamedParams` boolean available that can be used -such as `{{ if .IsNamedParams }}...{{ else }}...{{ end }}`. See the -`Single Flexible Example` below for an example. - -You can also use the variable `.Page` to access all the normal [Page Variables](/templates/variables/). - -A shortcodes can be nested. In a nested shortcode you can access the parent shortcode context with `.Parent`. This can be very useful for inheritance of common shortcode parameters from the root. - -## Single Positional Example: youtube - - {{</* youtube 09jf3ow9jfw */>}} - -Would load the template /layouts/shortcodes/youtube.html - - <div class="embed video-player"> - <iframe class="youtube-player" type="text/html" width="640" height="385" src="http://www.youtube.com/embed/{{ index .Params 0 }}" allowfullscreen frameborder="0"> - </iframe> - </div> - -This would be rendered as: - - <div class="embed video-player"> - <iframe class="youtube-player" type="text/html" - width="640" height="385" - src="http://www.youtube.com/embed/09jf3ow9jfw" - allowfullscreen frameborder="0"> - </iframe> - </div> - -## Single Named Example: image with caption - - {{</* img src="/media/spf13.jpg" title="Steve Francia" */>}} - -Would load the template /layouts/shortcodes/img.html - - <!-- image --> - <figure {{ with .Get "class" }}class="{{.}}"{{ end }}> - {{ with .Get "link"}}<a href="{{.}}">{{ end }} - <img src="{{ .Get "src" }}" {{ if or (.Get "alt") (.Get "caption") }}alt="{{ with .Get "alt"}}{{.}}{{else}}{{ .Get "caption" }}{{ end }}"{{ end }} /> - {{ if .Get "link"}}</a>{{ end }} - {{ if or (or (.Get "title") (.Get "caption")) (.Get "attr")}} - <figcaption>{{ if isset .Params "title" }} - <h4>{{ .Get "title" }}</h4>{{ end }} - {{ if or (.Get "caption") (.Get "attr")}}<p> - {{ .Get "caption" }} - {{ with .Get "attrlink"}}<a href="{{.}}"> {{ end }} - {{ .Get "attr" }} - {{ if .Get "attrlink"}}</a> {{ end }} - </p> {{ end }} - </figcaption> - {{ end }} - </figure> - <!-- image --> - -Would be rendered as: - - <figure > - <img src="/media/spf13.jpg" /> - <figcaption> - <h4>Steve Francia</h4> - </figcaption> - </figure> - -## Single Flexible Example: vimeo with defaults - - {{</* vimeo 49718712 */>}} - {{</* vimeo id="49718712" class="flex-video" */>}} - -Would load the template /layouts/shortcodes/vimeo.html - - {{ if .IsNamedParams }} - <div class="{{ if .Get "class" }}{{ .Get "class" }}{{ else }}vimeo-container{{ end }}"> - <iframe src="//player.vimeo.com/video/{{ .Get "id" }}" allowfullscreen></iframe> - </div> - {{ else }} - <div class="{{ if len .Params | eq 2 }}{{ .Get 1 }}{{ else }}vimeo-container{{ end }}"> - <iframe src="//player.vimeo.com/video/{{ .Get 0 }}" allowfullscreen></iframe> - </div> - {{ end }} - -Would be rendered as: - - <div class="vimeo-container"> - <iframe src="//player.vimeo.com/video/49718712" allowfullscreen></iframe> - </div> - <div class="flex-video"> - <iframe src="//player.vimeo.com/video/49718712" allowfullscreen></iframe> - </div> - -## Paired Example: Highlight -*Hugo already ships with the `highlight` shortcode* - - {{</* highlight html */>}} - <html> - <body> This HTML </body> - </html> - {{</* /highlight */>}} - -The template for this utilizes the following code (already included in Hugo) - - {{ .Get 0 | highlight .Inner }} - -And will be rendered as: - - <div class="highlight" style="background: #272822"><pre style="line-height: 125%"><span style="color: #f92672"><html></span> - <span style="color: #f92672"><body></span> This HTML <span style="color: #f92672"></body></span> - <span style="color: #f92672"></html></span> - </pre></div> - -Please notice that this template makes use of a Hugo-specific template function -called `highlight` which uses Pygments to add the highlighting code. - -## Simple Single-word Example: Year - -Let's assume you would like to have a shortcode to be replaced by the current year in your Markdown content files, for a license or copyright statement. Calling a shortcode like this: - - {{</* year */>}} - -... would load your one-line template ``/layouts/shortcodes/year.html``, which contains: - - {{ .Page.Now.Year }} - -More shortcode examples can be found at [spf13.com](https://github.com/spf13/spf13.com/tree/master/layouts/shortcodes). diff --git a/docs/content/extras/toc.md b/docs/content/extras/toc.md deleted file mode 100644 index 56e093ba7..000000000 --- a/docs/content/extras/toc.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -lastmod: 2015-01-27 -date: 2013-07-09 -menu: - main: - parent: extras -next: /extras/localfiles -prev: /extras/highlighting -title: Table of Contents ---- - -Hugo will automatically parse the Markdown for your content and create -a Table of Contents you can use to guide readers to the sections within -your content. - -## Usage - -Simply create content like you normally would with the appropriate -headers. - -Hugo will take this Markdown and create a table of contents stored in the -[content variable](/layout/variables/) `.TableOfContents` - - -## Template Example - -This is example code of a [single.html template](/layout/content/). - - {{ partial "header.html" . }} - <div id="toc" class="well col-md-4 col-sm-6"> - {{ .TableOfContents }} - </div> - <h1>{{ .Title }}</h1> - {{ .Content }} - {{ partial "footer.html" . }} - - diff --git a/docs/content/extras/urls.md b/docs/content/extras/urls.md deleted file mode 100644 index 487e685f3..000000000 --- a/docs/content/extras/urls.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -aliases: -- /doc/urls/ -lastmod: 2016-05-07 -date: 2014-01-03 -menu: - main: - parent: extras -next: /community/mailing-list -notoc: true -prev: /extras/localfiles -title: URLs ---- - -## Pretty URLs - -By default, Hugo creates content with 'pretty' URLs. For example, -content created at `/content/extras/urls.md` will be rendered at -`/public/extras/urls/index.html`, thus accessible from the browser -at http://example.com/extras/urls/. No non-standard server-side -configuration is required for these pretty URLs to work. - -If you would like to have what we call "ugly URLs", -e.g. http://example.com/extras/urls.html, you are in luck. -Hugo supports the ability to create your entire site with ugly URLs. -Simply add `uglyurls = true` to your site-wide `config.toml`, -or use the `--uglyURLs=true` flag on the command line. - -If you want a specific piece of content to have an exact URL, you can -specify this in the front matter under the `url` key. See [Content -Organization](/content/organization/) for more details. - -## Canonicalization - -By default, all relative URLs encountered in the input are left unmodified, -e.g. `/css/foo.css` would stay as `/css/foo.css`, -i.e. `canonifyURLs` defaults to `false`. - -By setting `canonifyURLs` to `true`, all relative URLs would instead -be *canonicalized* using `baseURL`. For example, assuming you have -`baseURL = http://yoursite.example.com/` defined in the site-wide -`config.toml`, the relative URL `/css/foo.css` would be turned into -the absolute URL `http://yoursite.example.com/css/foo.css`. - -Benefits of canonicalization include fixing all URLs to be absolute, which may -aid with some parsing tasks. Note though that all real browsers handle this -client-side without issues. - -Benefits of non-canonicalization include being able to have resource inclusion -be scheme-relative, so that http vs https can be decided based on how this -page was retrieved. - -> Note: In the May 2014 release of Hugo v0.11, the default value of `canonifyURLs` was switched from `true` to `false`, which we think is the better default and should continue to be the case going forward. So, please verify and adjust your website accordingly if you are upgrading from v0.10 or older versions. - -To find out the current value of `canonifyURLs` for your website, you may use the handy `hugo config` command added in v0.13: - - hugo config | grep -i canon - -Or, if you are on Windows and do not have `grep` installed: - - hugo config | FINDSTR /I canon - -## Relative URLs - -By default, all relative URLs are left unchanged by Hugo, -which can be problematic when you want to make your site browsable from a local file system. - -Setting `relativeURLs` to `true` in the site configuration will cause Hugo to rewrite all relative URLs to be relative to the current content. - -For example, if the `/post/first/` page contained a link with a relative URL of `/about/`, Hugo would rewrite that URL to `../../about/`. diff --git a/docs/content/meta/license.md b/docs/content/meta/license.md deleted file mode 100644 index a16923bfb..000000000 --- a/docs/content/meta/license.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -aliases: -- /doc/license/ -- /license/ -- /meta/license/ -lastmod: 2015-11-25 -date: 2013-07-01 -menu: - main: - parent: about -title: License -weight: 50 ---- - -Hugo v0.15 and later are released under the Apache 2.0 license. -Earlier releases were under the Simple Public License. - -Apache License -============== - -_Version 2.0, January 2004_ -_<<http://www.apache.org/licenses/>>_ - -### Terms and Conditions for use, reproduction, and distribution - -#### 1. Definitions - -“License” shall mean the terms and conditions for use, reproduction, and -distribution as defined by Sections 1 through 9 of this document. - -“Licensor” shall mean the copyright owner or entity authorized by the copyright -owner that is granting the License. - -“Legal Entity” shall mean the union of the acting entity and all other entities -that control, are controlled by, or are under common control with that entity. -For the purposes of this definition, “control” means **(i)** the power, direct or -indirect, to cause the direction or management of such entity, whether by -contract or otherwise, or **(ii)** ownership of fifty percent (50%) or more of the -outstanding shares, or **(iii)** beneficial ownership of such entity. - -“You” (or “Your”) shall mean an individual or Legal Entity exercising -permissions granted by this License. - -“Source” form shall mean the preferred form for making modifications, including -but not limited to software source code, documentation source, and configuration -files. - -“Object” form shall mean any form resulting from mechanical transformation or -translation of a Source form, including but not limited to compiled object code, -generated documentation, and conversions to other media types. - -“Work” shall mean the work of authorship, whether in Source or Object form, made -available under the License, as indicated by a copyright notice that is included -in or attached to the work (an example is provided in the Appendix below). - -“Derivative Works” shall mean any work, whether in Source or Object form, that -is based on (or derived from) the Work and for which the editorial revisions, -annotations, elaborations, or other modifications represent, as a whole, an -original work of authorship. For the purposes of this License, Derivative Works -shall not include works that remain separable from, or merely link (or bind by -name) to the interfaces of, the Work and Derivative Works thereof. - -“Contribution” shall mean any work of authorship, including the original version -of the Work and any modifications or additions to that Work or Derivative Works -thereof, that is intentionally submitted to Licensor for inclusion in the Work -by the copyright owner or by an individual or Legal Entity authorized to submit -on behalf of the copyright owner. For the purposes of this definition, -“submitted” means any form of electronic, verbal, or written communication sent -to the Licensor or its representatives, including but not limited to -communication on electronic mailing lists, source code control systems, and -issue tracking systems that are managed by, or on behalf of, the Licensor for -the purpose of discussing and improving the Work, but excluding communication -that is conspicuously marked or otherwise designated in writing by the copyright -owner as “Not a Contribution.” - -“Contributor” shall mean Licensor and any individual or Legal Entity on behalf -of whom a Contribution has been received by Licensor and subsequently -incorporated within the Work. - -#### 2. Grant of Copyright License - -Subject to the terms and conditions of this License, each Contributor hereby -grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, -irrevocable copyright license to reproduce, prepare Derivative Works of, -publicly display, publicly perform, sublicense, and distribute the Work and such -Derivative Works in Source or Object form. - -#### 3. Grant of Patent License - -Subject to the terms and conditions of this License, each Contributor hereby -grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, -irrevocable (except as stated in this section) patent license to make, have -made, use, offer to sell, sell, import, and otherwise transfer the Work, where -such license applies only to those patent claims licensable by such Contributor -that are necessarily infringed by their Contribution(s) alone or by combination -of their Contribution(s) with the Work to which such Contribution(s) was -submitted. If You institute patent litigation against any entity (including a -cross-claim or counterclaim in a lawsuit) alleging that the Work or a -Contribution incorporated within the Work constitutes direct or contributory -patent infringement, then any patent licenses granted to You under this License -for that Work shall terminate as of the date such litigation is filed. - -#### 4. Redistribution - -You may reproduce and distribute copies of the Work or Derivative Works thereof -in any medium, with or without modifications, and in Source or Object form, -provided that You meet the following conditions: - -* **(a)** You must give any other recipients of the Work or Derivative Works a copy of -this License; and -* **(b)** You must cause any modified files to carry prominent notices stating that You -changed the files; and -* **(c)** You must retain, in the Source form of any Derivative Works that You distribute, -all copyright, patent, trademark, and attribution notices from the Source form -of the Work, excluding those notices that do not pertain to any part of the -Derivative Works; and -* **(d)** If the Work includes a “NOTICE” text file as part of its distribution, then any -Derivative Works that You distribute must include a readable copy of the -attribution notices contained within such NOTICE file, excluding those notices -that do not pertain to any part of the Derivative Works, in at least one of the -following places: within a NOTICE text file distributed as part of the -Derivative Works; within the Source form or documentation, if provided along -with the Derivative Works; or, within a display generated by the Derivative -Works, if and wherever such third-party notices normally appear. The contents of -the NOTICE file are for informational purposes only and do not modify the -License. You may add Your own attribution notices within Derivative Works that -You distribute, alongside or as an addendum to the NOTICE text from the Work, -provided that such additional attribution notices cannot be construed as -modifying the License. - -You may add Your own copyright statement to Your modifications and may provide -additional or different license terms and conditions for use, reproduction, or -distribution of Your modifications, or for any such Derivative Works as a whole, -provided Your use, reproduction, and distribution of the Work otherwise complies -with the conditions stated in this License. - -#### 5. Submission of Contributions - -Unless You explicitly state otherwise, any Contribution intentionally submitted -for inclusion in the Work by You to the Licensor shall be under the terms and -conditions of this License, without any additional terms or conditions. -Notwithstanding the above, nothing herein shall supersede or modify the terms of -any separate license agreement you may have executed with Licensor regarding -such Contributions. - -#### 6. Trademarks - -This License does not grant permission to use the trade names, trademarks, -service marks, or product names of the Licensor, except as required for -reasonable and customary use in describing the origin of the Work and -reproducing the content of the NOTICE file. - -#### 7. Disclaimer of Warranty - -Unless required by applicable law or agreed to in writing, Licensor provides the -Work (and each Contributor provides its Contributions) on an “AS IS” BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, -including, without limitation, any warranties or conditions of TITLE, -NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are -solely responsible for determining the appropriateness of using or -redistributing the Work and assume any risks associated with Your exercise of -permissions under this License. - -#### 8. Limitation of Liability - -In no event and under no legal theory, whether in tort (including negligence), -contract, or otherwise, unless required by applicable law (such as deliberate -and grossly negligent acts) or agreed to in writing, shall any Contributor be -liable to You for damages, including any direct, indirect, special, incidental, -or consequential damages of any character arising as a result of this License or -out of the use or inability to use the Work (including but not limited to -damages for loss of goodwill, work stoppage, computer failure or malfunction, or -any and all other commercial damages or losses), even if such Contributor has -been advised of the possibility of such damages. - -#### 9. Accepting Warranty or Additional Liability - -While redistributing the Work or Derivative Works thereof, You may choose to -offer, and charge a fee for, acceptance of support, warranty, indemnity, or -other liability obligations and/or rights consistent with this License. However, -in accepting such obligations, You may act only on Your own behalf and on Your -sole responsibility, not on behalf of any other Contributor, and only if You -agree to indemnify, defend, and hold each Contributor harmless for any liability -incurred by, or claims asserted against, such Contributor by reason of your -accepting any such warranty or additional liability. - -_END OF TERMS AND CONDITIONS_ - -### APPENDIX: How to apply the Apache License to your work - -To apply the Apache License to your work, attach the following boilerplate -notice, with the fields enclosed by brackets `[]` replaced with your own -identifying information. (Don't include the brackets!) The text should be -enclosed in the appropriate comment syntax for the file format. We also -recommend that a file or class name and description of purpose be included on -the same “printed page” as the copyright notice for easier identification within -third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/docs/content/meta/roadmap.md b/docs/content/meta/roadmap.md deleted file mode 100644 index 13395fed4..000000000 --- a/docs/content/meta/roadmap.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -aliases: -- /doc/roadmap/ -- /meta/roadmap/ -lastmod: 2015-02-16 -date: 2013-07-01 -menu: - main: - parent: about -notoc: true -title: Hugo Roadmap -weight: 20 ---- - -In no particular order, here is what we are working on: - - * Intelligently related posts ([#98][]) - * Even easier deployment to S3, SSH, GitHub, rsync. Give the [tools section](https://gohugo.io/tools/#deployment) a shot or read one of the related tutorials. - * Import from other website systems. There are already existing [migration tools](https://gohugo.io/tools/#migration) but they don't cover all major platforms. - * An interactive web based editor (See https://discuss.gohugo.io/t/web-based-editor/155) - * Additional [themes](https://github.com/gohugoio/hugoThemes) (always on-going, contributions welcome!) - * Dynamic image resizing via shortcodes ([#1014][]) - * Native support for additional content formats (AsciiDoc [#1435][], reST [#1436][]) - * And, last but not least, ***Your best ideas***! - -[#100]: https://github.com/gohugoio/hugo/issues/100 "hugo import from wordpress · Issue #100 · gohugoio/hugo" -[#101]: https://github.com/gohugoio/hugo/issues/101 "hugo import from jekyll · Issue #101 · gohugoio/hugo" -[#1435]: https://github.com/gohugoio/hugo/issues/1435 "Add support for native Go implementation of AsciiDoc · Issue #1435 · gohugoio/hugo" -[#1436]: https://github.com/gohugoio/hugo/issues/1436 "Add support for native Go implementation of reStructuredText (reST) · Issue #1436 · gohugoio/hugo" -[#1014]: https://github.com/gohugoio/hugo/issues/1014 "Image Resizing and Cropping · Issue #1014 · gohugoio/hugo" -[#98]: https://github.com/gohugoio/hugo/issues/98 "Add support for related content · Issue #98 · gohugoio/hugo" - -> Feel free to [contribute]({{< relref "tutorials/how-to-contribute-to-hugo.md" >}}) or open a [new issue](https://github.com/gohugoio/hugo/issues/new) if you have an idea for a new feature.) diff --git a/docs/content/overview/configuration.md b/docs/content/overview/configuration.md deleted file mode 100644 index 7d05570b7..000000000 --- a/docs/content/overview/configuration.md +++ /dev/null @@ -1,458 +0,0 @@ ---- -aliases: -- /doc/configuration/ -lastmod: 2016-09-17 -date: 2013-07-01 -linktitle: Configuration -menu: - main: - parent: getting started -next: /overview/source-directory -toc: true -prev: /overview/usage -title: Configuring Hugo -weight: 40 ---- -The directory structure of a Hugo web site—or more precisely, -of the source files containing its content and templates—provide -most of the configuration information that Hugo needs. -Therefore, in essence, -many web sites wouldn't actually need a configuration file. -This is because Hugo is designed to recognize certain typical usage patterns -(and it expects them, by default). - -Nevertheless, Hugo does search for a configuration file bearing -a particular name in the root of your web site's source directory. -First, it looks for a `./config.toml` file. -If that's not present, it will seek a `./config.yaml` file, -followed by a `./config.json` file. - -In this `config` file for your web site, -you can include precise directions to Hugo regarding -how it should render your site, as well as define its menus, -and set various other site-wide parameters. - -Another way that web site configuration can be accomplished is through -operating system environment variables. -For instance, the following command will work on Unix-like systems—it -sets a web site's title: -```bash -$ env HUGO_TITLE="Some Title" hugo -``` -(**Note:** all such environment variable names must be prefixed with -<code>HUGO_</code>.) - -## Examples - -Following is a typical example of a YAML configuration file. -Three periods end the document: - -```yaml ---- -baseURL: "http://yoursite.example.com/" -... -``` -Following is an example TOML configuration file with some default values. -The values under `[params]` will populate the `.Site.Params` variable -for use in templates: - -```toml -contentDir = "content" -layoutDir = "layouts" -publishDir = "public" -buildDrafts = false -baseURL = "http://yoursite.example.com/" -canonifyURLs = true - -[taxonomies] - category = "categories" - tag = "tags" - -[params] - description = "Tesla's Awesome Hugo Site" - author = "Nikola Tesla" -``` -Here is a YAML configuration file which sets a few more options: - -```yaml ---- -baseURL: "http://yoursite.example.com/" -title: "Yoyodyne Widget Blogging" -footnoteReturnLinkContents: "↩" -permalinks: - post: /:year/:month/:title/ -params: - Subtitle: "Spinning the cogs in the widgets" - AuthorName: "John Doe" - GitHubUser: "spf13" - ListOfFoo: - - "foo1" - - "foo2" - SidebarRecentLimit: 5 -... -``` -## Configuration variables - -Following is a list of Hugo-defined variables you can configure, -along with their current, default values: - - --- - archetypeDir: "archetypes" - # hostname (and path) to the root, e.g. http://spf13.com/ - baseURL: "" - # include content marked as draft - buildDrafts: false - # include content with publishdate in the future - buildFuture: false - # include content already expired - buildExpired: false - # enable this to make all relative URLs relative to content root. Note that this does not affect absolute URLs. - relativeURLs: false - canonifyURLs: false - # config file (default is path/config.yaml|json|toml) - config: "config.toml" - contentDir: "content" - dataDir: "data" - defaultExtension: "html" - defaultLayout: "post" - # Missing translations will default to this content language - defaultContentLanguage: "en" - # Renders the default content language in subdir, e.g. /en/. The root directory / will redirect to /en/ - defaultContentLanguageInSubdir: false - # The below example will disable all page types and will render nothing. - disableKinds = ["page", "home", "section", "taxonomy", "taxonomyTerm", "RSS", "sitemap", "robotsTXT", "404"] - disableLiveReload: false - # Do not build RSS files - disableRSS: false - # Do not build Sitemap file - disableSitemap: false - # Enable GitInfo feature - enableGitInfo: false - # Build robots.txt file - enableRobotsTXT: false - # Do not render 404 page - disable404: false - # Do not inject generator meta tag on homepage - disableHugoGeneratorInject: false - # Enable Emoji emoticons support for page content. - # See www.emoji-cheat-sheet.com - enableEmoji: false - # Show a placeholder instead of the default value or an empty string if a translation is missing - enableMissingTranslationPlaceholders: false - footnoteAnchorPrefix: "" - footnoteReturnLinkContents: "" - # google analytics tracking id - googleAnalytics: "" - languageCode: "" - layoutDir: "layouts" - # Enable Logging - log: false - # Log File path (if set, logging enabled automatically) - logFile: "" - # "yaml", "toml", "json" - metaDataFormat: "toml" - # Edit new content with this editor, if provided - newContentEditor: "" - # Don't sync permission mode of files - noChmod: false - # Don't sync modification time of files - noTimes: false - paginate: 10 - paginatePath: "page" - permalinks: - # Pluralize titles in lists using inflect - pluralizeListTitles: true - # Preserve special characters in taxonomy names ("Gérard Depardieu" vs "Gerard Depardieu") - preserveTaxonomyNames: false - # filesystem path to write files to - publishDir: "public" - # enables syntax guessing for code fences without specified language - pygmentsCodeFencesGuessSyntax: false - # color-codes for highlighting derived from this style - pygmentsStyle: "monokai" - # true: use pygments-css or false: color-codes directly - pygmentsUseClasses: false - # maximum number of items in the RSS feed - rssLimit: 15 - # default sitemap configuration map - sitemap: - # filesystem path to read files relative from - source: "" - staticDir: "static" - # display memory and timing of different steps of the program - stepAnalysis: false - # theme to use (located by default in /themes/THEMENAME/) - themesDir: "themes" - theme: "" - title: "" - # if true, use /filename.html instead of /filename/ - uglyURLs: false - # Do not make the url/path to lowercase - disablePathToLower: false - # if true, auto-detect Chinese/Japanese/Korean Languages in the content. (.Summary and .WordCount can work properly in CJKLanguage) - hasCJKLanguage: false - # verbose output - verbose: false - # verbose logging - verboseLog: false - # watch filesystem for changes and recreate as needed - watch: true - --- - -## Ignore various files when rendering - -The following statement inside `./config.toml` will cause Hugo to ignore files -ending with `.foo` and `.boo` when rendering: - -```toml -ignoreFiles = [ "\\.foo$", "\\.boo$" ] -``` -The above is a list of regular expressions. -Note that the backslash (`\`) character is escaped, to keep TOML happy. - -## Configure Blackfriday rendering - -[Blackfriday](https://github.com/russross/blackfriday) is Hugo's -[Markdown](http://daringfireball.net/projects/markdown/) -rendering engine. - -In the main, Hugo typically configures Blackfriday with a sane set of defaults. -These defaults should fit most use cases, reasonably well. - -However, if you have unusual needs with respect to Markdown, -Hugo exposes some of its Blackfriday behavior options for you to alter. -The following table lists these Hugo options, -paired with the corresponding flags from Blackfriday's source code (for the latter, see -[html.go](https://github.com/russross/blackfriday/blob/master/html.go) and -[markdown.go](https://github.com/russross/blackfriday/blob/master/markdown.go)): - -<table class="table table-bordered-configuration"> - <thead> - <tr> - <th>Flag</th> - <th>Default</th> - <th>Blackfriday flag</th> - </tr> - </thead> - <tbody> - <tr> - <td><code><strong>taskLists</strong></code></td> - <td><code>true</code></td> - <td><code></code></td> - </tr> - <tr> - <td class="purpose-description" colspan="3"> - <span class="purpose-title">Purpose:</span> - <code>false</code> turns off GitHub-style automatic task/TODO - list generation. - </td> - </tr> - <tr> - <td><code><strong>smartypants</strong></code></td> - <td><code>true</code></td> - <td><code>HTML_USE_SMARTYPANTS</code></td> - </tr> - <tr> - <td class="purpose-description" colspan="3"> - <span class="purpose-title">Purpose:</span> - <code>false</code> disables smart punctuation substitutions - including smart quotes, smart dashes, smart fractions, etc. - If <code>true</code>, it may be fine-tuned with the - <code>angledQuotes</code>, - <code>fractions</code>, - <code>smartDashes</code> and - <code>latexDashes</code> flags (see below). - </td> - </tr> - <tr> - <td><code><strong>angledQuotes</strong></code></td> - <td><code>false</code></td> - <td><code>HTML_SMARTYPANTS_ANGLED_QUOTES</code></td> - </tr> - <tr> - <td class="purpose-description" colspan="3"> - <span class="purpose-title">Purpose:</span> - <code>true</code> enables smart, angled double quotes.<br> - <small> - <strong>Example:</strong> - <code>"Hugo"</code> renders to - «Hugo» instead of “Hugo”. - </small> - </td> - </tr> - <tr> - <td><code><strong>fractions</strong></code></td> - <td><code>true</code></td> - <td><code>HTML_SMARTYPANTS_FRACTIONS</code></td> - </tr> - <tr> - <td class="purpose-description" colspan="3"> - <span class="purpose-title">Purpose:</span> - <code>false</code> disables smart fractions.<br> - <small> - <strong>Example:</strong> - <code>5/12</code> renders to - <sup>5</sup>⁄<sub>12</sub> - (<code><sup>5</sup>&frasl;<sub>12</sub></code>).<br> - <strong>Caveat:</strong> - Even with <code>fractions = false</code>, - Blackfriday still converts - 1/2, 1/4 and 3/4 respectively to - ½ (<code>&frac12;</code>), - ¼ (<code>&frac14;</code>) and - ¾ (<code>&frac34;</code>), - but only these three.</small> - </td> - </tr> - <tr> - <td><code><strong>smartDashes</strong></code></td> - <td><code>true</code></td> - <td><code>HTML_SMARTYPANTS_DASHES</code></td> - </tr> - <tr> - <td class="purpose-description" colspan="3"> - <span class="purpose-title">Purpose:</span> - <code>false</code> disables smart dashes; i.e., the conversion - of multiple hyphens into en dash or em dash. - If <code>true</code>, its behavior can be modified with the - <code>latexDashes</code> flag below. - </td> - </tr> - <tr> - <td><code><strong>latexDashes</strong></code></td> - <td><code>true</code></td> - <td><code>HTML_SMARTYPANTS_LATEX_DASHES</code></td> - </tr> - <tr> - <td class="purpose-description" colspan="3"> - <span class="purpose-title">Purpose:</span> - <code>false</code> disables LaTeX-style smart dashes and - selects conventional smart dashes. Assuming - <code>smartDashes</code> (above), if this is: - <ul> - <li> - <strong><code>true</code>,</strong> then - <code>--</code> is translated into “–” - (<code>&ndash;</code>), whereas - <code>---</code> is translated into “—” - (<code>&mdash;</code>). - </li> - <li> - <strong><code>false</code>,</strong> then - <code>--</code> is translated into “—” - (<code>&mdash;</code>), whereas a - <em>spaced</em> single hyphen between two words - is translated into an en dash—e.g., - <code>12 June - 3 July</code> becomes - <code>12 June &ndash; 3 July</code>. - </li> - </ul> - </td> - </tr> - <tr> - <td><code><strong>hrefTargetBlank</strong></code></td> - <td><code>false</code></td> - <td><code>HTML_HREF_TARGET_BLANK</code></td> - </tr> - <tr> - <td class="purpose-description" colspan="3"> - <span class="purpose-title">Purpose:</span> - <code>true</code> opens external links in a new window or tab. - </td> - </tr> - <tr> - <td><code><strong>plainIDAnchors</strong></code></td> - <td><code>true</code></td> - <td> - <code>FootnoteAnchorPrefix</code> and - <code>HeaderIDSuffix</code> - </td> - </tr> - <tr> - <td class="purpose-description" colspan="3"> - <span class="purpose-title">Purpose:</span> - <code>true</code> renders any header and footnote IDs - without the document ID.<br> - <small> - <strong>Example:</strong> - renders <code>#my-header</code> instead of - <code>#my-header:bec3ed8ba720b9073ab75abcf3ba5d97</code>. - </small> - </td> - </tr> - <tr> - <td><code><strong>extensions</strong></code></td> - <td><code>[]</code></td> - <td><code>EXTENSION_*</code></td> - </tr> - <tr> - <td class="purpose-description" colspan="3"> - <span class="purpose-title">Purpose:</span> - Enable one or more of Blackfriday's Markdown extensions - (if they aren't Hugo defaults).<br> - <small> - <strong>Example:</strong> - Include <code>"hardLineBreak"</code> - in the list to enable Blackfriday's - <code>EXTENSION_HARD_LINE_BREAK</code>. - </small> - </td> - </tr> - <tr> - <td><code><strong>extensionsmask</strong></code></td> - <td><code>[]</code></td> - <td><code>EXTENSION_*</code></td> - </tr> - <tr> - <td class="purpose-description" colspan="3"> - <span class="purpose-title">Purpose:</span> - Disable one or more of Blackfriday's Markdown extensions - (if they are Hugo defaults).<br> - <small> - <strong>Example:</strong> - Include <code>"autoHeaderIds"</code> - in the list to disable Blackfriday's - <code>EXTENSION_AUTO_HEADER_IDS</code>. - </small> - </td> - </tr> - </tbody> -</table> - -**Notes** - -* These flags are **case sensitive** (as of Hugo v0.15)! -* These flags must be grouped under the `blackfriday` key -and can be set on **both the site level and the page level**. -Any setting on a page will override the site setting -there. For example: - -<table class="table"> - <thead> - <tr> - <th>TOML</th> - <th>YAML</th> - </tr> - </thead> - <tbody> - <tr style="vertical-align: top;"> - <td style="width: 50%;"> -<pre><code>[blackfriday] - angledQuotes = true - fractions = false - plainIDAnchors = true - extensions = ["hardLineBreak"] -</code></pre> - </td> - <td> -<pre><code>blackfriday: - angledQuotes: true - fractions: false - plainIDAnchors: true - extensions: - - hardLineBreak -</code></pre> - </td> - </tr> - </tbody> -</table> diff --git a/docs/content/overview/installing.md b/docs/content/overview/installing.md deleted file mode 100644 index 1249d4630..000000000 --- a/docs/content/overview/installing.md +++ /dev/null @@ -1,138 +0,0 @@ - ---- -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 -<i class="fa fa-windows"></i> Windows, -<i class="fa fa-linux"></i> Linux, -<i class="fa freebsd-19px"></i> FreeBSD -and <i class="fa fa-apple"></i> 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`. - -## 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/spf13/Hugo/ (updated to Hugo v0.16) -* https://copr.fedorainfracloud.org/coprs/daftaupe/hugo/ (updated to Hugo v0.22) : usually released a few days after the official Hugo release. - -See also [this discussion](https://discuss.gohugo.io/t/solved-fedora-copr-repository-out-of-service/2491). - -### Snap package for Hugo - -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). - -## 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 - - 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` -(or `hugo.exe`) executable, which you will find sitting inside -`$HOME/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 --git a/docs/content/overview/introduction.md b/docs/content/overview/introduction.md deleted file mode 100644 index 305ddce37..000000000 --- a/docs/content/overview/introduction.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -lastmod: 2016-08-14 -date: 2013-07-01 -linktitle: Introduction -menu: - main: - parent: getting started -next: /overview/quickstart -title: Introduction to Hugo -weight: 5 ---- - -## What is Hugo? - -Hugo is a general-purpose website framework. Technically speaking, Hugo is -a static site generator. Unlike other systems which dynamically build a page -every time a visitor requests one, Hugo does the building when you create -your content. Since websites are viewed far more often than they are -edited, Hugo is optimized for website viewing while providing a great -writing experience. - -Sites built with Hugo are extremely fast and very secure. Hugo sites can -be hosted anywhere, including [Heroku][], [GoDaddy][], [DreamHost][], -[GitHub Pages][], [Netlify][], [Surge][], [Aerobatic][], [Firebase Hosting][], -[Google Cloud Storage][], [Amazon S3][] and [CloudFront][], and work well -with CDNs. Hugo sites run without dependencies on expensive runtimes -like Ruby, Python or PHP and without dependencies on any databases. - -[Heroku]: https://www.heroku.com/ -[GoDaddy]: https://www.godaddy.com/ -[DreamHost]: http://www.dreamhost.com/ -[GitLab]: https://about.gitlab.com -[GitHub Pages]: https://pages.github.com/ -[Aerobatic]: https://www.aerobatic.com/ -[Firebase Hosting]: https://firebase.google.com/docs/hosting/ -[Google Cloud Storage]: http://cloud.google.com/storage/ -[Amazon S3]: http://aws.amazon.com/s3/ -[CloudFront]: http://aws.amazon.com/cloudfront/ "Amazon CloudFront" -[Surge]: https://surge.sh -[Netlify]: https://www.netlify.com - -We think of Hugo as the ideal website creation tool. With nearly instant -build times and the ability to rebuild whenever a change is made, Hugo -provides a very fast feedback loop. This is essential when you are -designing websites, but also very useful when creating content. - -## What makes Hugo different? - -Web site generators render content into HTML files. Most are "dynamic -site generators." That means the HTTP -server (which is the program running on your website that the user's -browser talks to) runs the generator to create a new HTML file -each and every time a user wants to view a page. - -Creating the page dynamically means that the computer hosting -the HTTP server has to have enough memory and CPU to effectively run -the generator around the clock. If not, then the user has to wait -in a queue for the page to be generated. - -Nobody wants users to wait longer than needed, so the dynamic site -generators programmed their systems to cache the HTML files. When -a file is cached, a copy of it is temporarily stored on the computer. -It is much faster for the HTTP server to send that copy the next time -the page is requested than it is to generate it from scratch. - -Hugo takes caching a step further. All HTML files are rendered on your -computer. You can review the files before you copy them to the computer -hosting the HTTP server. Since the HTML files aren't generated dynamically, -we say that Hugo is a "static site generator." - -Not running a web site generator on your HTTP server has many benefits. -The most noticeable is performance - HTTP servers are very good at -sending files. So good that you can effectively serve the same number -of pages with a fraction of the memory and CPU needed for a dynamic site. - -Hugo has two components to help you build and test your web site. The -one that you'll probably use most often is the built-in HTTP server. -When you run `hugo server`, Hugo renders all of your content into -HTML files and then runs an HTTP server on your computer so that you -can see what the pages look like. - -The second component is used when you're ready to publish your web -site to the computer running your website. Running Hugo without any -actions will rebuild your entire web site using the `baseURL` setting -from your site's configuration file. That's required to have your page -links work properly with most hosting companies. - -## How fast is Hugo? - -{{% youtube CdiDYZ51a2o %}} - -## What does Hugo do? - -In technical terms, Hugo takes a source directory of files and -templates and uses these as input to create a complete website. - -Hugo boasts the following features: - -### General - - * Extremely fast build times (~1 ms per page) - * Completely cross platform: Runs on <i class="fa fa-apple"></i> macOS, <i class="fa fa-linux"></i> Linux, <i class="fa fa-windows"></i> Windows, and more! - * Easy [installation](/overview/installing/) - * Render changes [on the fly](/overview/usage/) with [LiveReload](/extras/livereload/) as you develop - * Complete theme support - * Host your site anywhere - -### Organization - - * Straightforward [organization](/content/organization/) - * Support for [website sections](/content/sections/) - * Completely customizable [URLs](/extras/urls/) - * Support for configurable [taxonomies](/taxonomies/overview/) which includes categories and tags. Create your own custom organization of content - * Ability to [sort content](/content/ordering/) as you desire - * Automatic [table of contents](/extras/toc/) generation - * Dynamic menu creation - * [Pretty URLs](/extras/urls/) support - * [Permalink](/extras/permalinks/) pattern support - * [Aliases](/extras/aliases/) (redirects) - -### Content - - * Native support for content written in [Markdown](/content/example/) - * Support for other languages through _external helpers_, see [supported formats](/content/supported-formats) - * Support for TOML, YAML and JSON metadata in [frontmatter](/content/front-matter/) - * Completely [customizable homepage](/layout/homepage/) - * Support for multiple [content types](/content/types/) - * Automatic and user defined [summaries](/content/summaries/) - * [Shortcodes](/extras/shortcodes/) to enable rich content inside of Markdown - * ["Minutes to Read"](/layout/variables/) functionality - * ["Wordcount"](/layout/variables/) functionality - -### Additional Features - - * Integrated [Disqus](https://disqus.com/) comment support - * Integrated [Google Analytics](https://google-analytics.com/) support - * Automatic [RSS](/layout/rss/) creation - * Support for [Go](http://golang.org/pkg/html/template/), [Amber](https://github.com/eknkc/amber) and [Ace](https://github.com/yosssi/ace) HTML templates - * Syntax [highlighting](/extras/highlighting/) powered by [Pygments](http://pygments.org/) - -See what's coming next in the [roadmap](/meta/roadmap/). - -## Who should use Hugo? - -Hugo is for people that prefer writing in a text editor over -a browser. - -Hugo is for people who want to hand code their own website without -worrying about setting up complicated runtimes, dependencies and -databases. - -Hugo is for people building a blog, company site, portfolio, tumblog, -documentation, single page site or a site with thousands of -pages. - -## Why did you write Hugo? - -I wrote Hugo ultimately for a few reasons. First, I was disappointed with -WordPress, my then website solution. With it, I couldn't create -content as efficiently as I wanted to. -It rendered slowly. It required me to be online to write -posts: plus its constant security updates and the horror stories of people's -hacked blogs! I hated how content for it was written only in HTML, instead of the much -simpler Markdown. Overall, I felt like WordPress got in my way -much more than it helped me. It kept -me from writing great content. - -I looked at the existing static site generators -like [Jekyll][], [Middleman][] and [Nanoc][]. -All had complicated installation dependencies and took far longer to render -my blog with its hundreds of posts than I felt was acceptable. I wanted -a framework to be able to give me rapid feedback while making changes to the -templates, and the 5+-minute render times were just too slow. In general, -they were also very blog minded and didn't have the ability to provide -other content types and flexible URLs. - -[Jekyll]: http://jekyllrb.com/ -[Middleman]: https://middlemanapp.com/ -[Nanoc]: http://nanoc.ws/ - -I wanted to develop a fast and full-featured website framework without any -dependencies. The [Go language][] seemed to have all the features I needed -in a language. I began developing Hugo in Go and fell in love with the -language. I hope you will enjoy using Hugo (and contributing to it) as much -as I have writing it. - -—Steve Francia (@spf13) - -[Go language]: http://golang.org/ "The Go Programming Language" - -## Next Steps - - * [Install Hugo](/overview/installing/) - * [Quick start](/overview/quickstart/) - * [Join the Mailing List](/community/mailing-list/) - * [Star us on GitHub](https://github.com/gohugoio/hugo) - * [Discussion Forum](http://discuss.gohugo.io/) diff --git a/docs/content/overview/quickstart.md b/docs/content/overview/quickstart.md deleted file mode 100644 index 7340a4957..000000000 --- a/docs/content/overview/quickstart.md +++ /dev/null @@ -1,573 +0,0 @@ ---- -lastmod: 2016-10-20 -date: 2013-07-01 -linktitle: Quickstart -menu: - main: - parent: getting started -next: /overview/installing -prev: /overview/introduction -title: Hugo Quickstart Guide -weight: 10 ---- - -Building a bookshelf ---- - -In this quickstart, we will build an online bookshelf that will list books and their reviews. - -> _Note: This quickstart depends on features introduced in Hugo v0.15. If you have an earlier version of Hugo, you will need to [upgrade](/overview/installing/) before proceeding._ - -{{% youtube w7Ft2ymGmfc %}} - -## Step 1. Install Hugo - -Go to [Hugo Releases](https://github.com/gohugoio/hugo/releases) and download the -appropriate version for your OS and architecture. - -Save the main executable as `hugo` (or `hugo.exe` on Windows) somewhere in your `PATH` as we will be using it in the next step. - -More complete instructions are available -at [Installing Hugo]({{< relref "overview/installing.md" >}}). - -If you're on Windows, this quickstart will assume -you're using [Git Bash](https://git-for-windows.github.io/) -(also known as Git for Windows). -Thus all commands will begin with the Bash prompt character (which is `$`). - -Once `hugo` is installed, make sure to run the `help` command to verify `hugo` installation. Below you can see part of the `help` command output for brevity. - -```bash -$ hugo help -``` -``` -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/. -``` - -You can check `hugo` version using the command shown below. - -```bash -$ hugo version -``` -``` -Hugo Static Site Generator v0.15 BuildDate: 2015-11-26T11:59:00+05:30 -``` - -## Step 2. Scaffold bookshelf hugo site - -Hugo has commands that allows us to quickly scaffold a Hugo managed website. Navigate to a convenient location on your filesystem and create a new Hugo site `bookshelf` by executing the following command. - -```bash -$ hugo new site bookshelf -``` - -Change directory to `bookshelf` and you will see the following directory layout. - -```bash -$ tree -a -``` -``` -. -|-- archetypes -|-- config.toml -|-- content -|-- data -|-- layouts -|-- static -`-- themes - -6 directories, 1 file -``` - -As mentioned in the command output, `bookshelf` directory has 6 sub-directories and 1 file. Let's look at each of them one by one. - -* **archetypes**: You can create new content files in Hugo using the `hugo new` command. When you run that command, it adds few configuration properties to the post like date and title. [Archetype]({{< relref "content/archetypes.md" >}}) allows you to define your own configuration properties that will be added to the post front matter whenever `hugo new` command is used. - -* **config.toml**: Every website should have a configuration file at the root. By default, the configuration file uses `TOML` format but you can also use `YAML` or `JSON` formats as well. [TOML](https://github.com/toml-lang/toml) is minimal configuration file format that's easy to read due to obvious semantics. The configuration settings mentioned in the `config.toml` are applied to the full site. These configuration settings include `baseURL` and `title` of the website. - -* **content**: This is where you will store content of the website. Inside content, you will create sub-directories for different sections. Let's suppose your website has three sections -- `blog`, `article`, and `tutorial` then you will have three different directories for each of them inside the `content` directory. The name of the section i.e. `blog`, `article`, or `tutorial` will be used by Hugo to apply a specific layout applicable to that section. - -* **data**: This directory is used to store configuration files that can be -used by Hugo when generating your website. -You can write these files in YAML, JSON, or TOML format. - -* **layouts**: The content inside this directory is used to specify how your content will be converted into the static website. - -* **static**: This directory is used to store all the static content that your website will need like images, CSS, JavaScript or other static content. - -* **themes**: This is where you will create a theme for your site to use. Themes provide the layout and templates that renders content. There's a wide variety of open-source themes available to download and use but you can also create your own if you prefer. - -## Step 3. Add content - -Let's now add a post to our `bookshelf`. We will use the `hugo new` command to add a post. In January, I read [Good To Great](http://www.amazon.com/Good-Great-Some-Companies-Others/dp/0066620996/) book so we will start with creating a post for it. **Make sure you are inside the `bookshelf` directory.** - -```bash -$ hugo new post/good-to-great.md -``` -``` -/Users/shekhargulati/bookshelf/content/post/good-to-great.md created -``` - -The above command will create a new directory `post` -inside the `bookshelf/content` directory -and create `good-to-great.md` file inside it. - -```bash -$ tree -a content -``` -``` -content -`-- post - `-- good-to-great.md - -1 directory, 1 file -``` - -The content inside the `good-to-great.md` file looks as shown below. - -``` -+++ -date = "2016-02-14T16:11:58+05:30" -draft = true -title = "good to great" - -+++ -``` - -The content inside `+++` is the TOML configuration for the post. -This configuration is called **front matter**. -It enables you to define post configuration along with its content. -By default, each post will have the three configuration properties shown above. - -* **date** specifies the date and time at which post was created. -* **draft** specifies that post is not ready for publication yet so it will not be in the generated site. -* **title** specifies title for the post. - -Let's add a small review for **Good to Great** book. - -``` -+++ -date = "2016-02-14T16:11:58+05:30" -draft = true -title = "Good to Great Book Review" - -+++ - -I read **Good to Great in January 2016**. An awesome read sharing detailed analysis on how good companies became great. -``` - -## Step 4. Serve content - -Hugo has an inbuilt server that can serve your website content so that you can preview it. You can also use the inbuilt Hugo server in production. To serve content, execute the following command inside the `bookshelf` directory. - -```bash -$ hugo server -``` -``` -0 of 1 draft rendered -0 future content -0 pages created -0 paginator pages created -0 tags created -0 categories created -in 9 ms -Watching for changes in /Users/shekhargulati/bookshelf/{data,content,layouts,static} -Serving pages from memory -Web Server is available at http://localhost:1313/ (bind address 127.0.0.1) -Press Ctrl+C to stop -``` - -This will start the server on port `1313`. -You can view your blog at http://localhost:1313/. -When you go to the link, you will see nothing. -There are couple of reasons for that: - -1. As you can see in the `hugo server` command output, Hugo didn't render the draft. Hugo will only render drafts if you pass the `buildDrafts` flag to the `hugo server` command. -2. We have not specified how Markdown content should be rendered. We have to specify a theme that Hugo can use. We will do that in the next step. - -To render drafts, re-run the server with command shown below. - -```bash -$ hugo server --buildDrafts -``` -``` -1 of 1 draft rendered -0 future content -1 pages created -0 paginator pages created -0 tags created -0 categories created -in 6 ms -Watching for changes in /Users/shekhargulati/bookshelf/{data,content,layouts,static} -Serving pages from memory -Web Server is available at http://localhost:1313/ (bind address 127.0.0.1) -Press Ctrl+C to stop -``` - -If you go to [http://localhost:1313/](http://localhost:1313/), -you still will not see anything as we have not specified a theme that Hugo should use. - -## Step 5. Add theme - -Themes provide the layout and templates that will be used by Hugo to render your website. There are a lot of Open-source themes available at [https://themes.gohugo.io/](https://themes.gohugo.io/) that you can use. - -> **Hugo currently doesn’t ship with a `default` theme, allowing the user to pick whichever theme best suits their project.** - -Themes should be added in the `themes` directory inside the repository root. - -```bash -$ cd themes -``` -Now, you can clone one or more themes inside the `themes` directory. -We will use the `robust` theme, -but at a commit (in its history) that works with this quickstart. - -```bash -$ git clone https://github.com/dim0627/hugo_theme_robust.git -$ (cd hugo_theme_robust; git checkout b8ce466) -``` - -Leave the themes folder. - -```bash -$ cd .. -``` - - -Start the server again. - -```bash -$ hugo server --theme=hugo_theme_robust --buildDrafts -``` -``` -1 of 1 draft rendered -0 future content -1 pages created -2 paginator pages created -0 tags created -0 categories created -in 10 ms -Watching for changes in /Users/shekhargulati/bookshelf/{data,content,layouts,static,themes} -Serving pages from memory -Web Server is available at http://localhost:1313/ (bind address 127.0.0.1) -Press Ctrl+C to stop -``` - -> *Note: If Hugo doesn't find the specified theme in the `themes` directory, -it will throw an exception as shown below.* -``` -FATAL: 2016/02/14 Unable to find theme Directory: /Users/shekhargulati/bookshelf/themes/robust -``` - -To view your website, you can go to http://localhost:1313/. You will see as shown below. - - - -Let's understand the layout of the theme. A theme consists of the following: - -* **theme.toml** is the theme configuration file that gives information -about the theme like name and description of theme, -author details, and theme license. - -* **images** directory contains two images -- `screenshot.png` and `tn.png`. `screenshot.png` is the image of the list view and `tn.png` is the single post view. - -* **layouts** directory contains different views for different content types. -Every content type should have two files `single.html` and `list.html`. -`single.html` is used for rendering a single piece of content. -`list.html` is used to view a list of content items. -For example, you will use `list.html` to view all the posts -that have the `programming` tag. - -* **static** directory stores all the static assets used by the template. -Static assets could be JavaScript libraries like jQuery or CSS styles or images, -or any other static content. -This directory will be copied into the final site when rendered. - -## Step 6. Use multiple themes - -You can very easily test different layouts by switching between different themes. -Let's suppose we want to try out the `bleak` theme. -We clone the `bleak` theme inside the `bookshelf/themes` directory. - -```bash -$ git clone https://github.com/Zenithar/hugo-theme-bleak.git -``` - -Restart the server using `hugo-theme-bleak` as shown below. - -```bash -$ hugo server --theme=hugo-theme-bleak --buildDrafts -``` - -Now, the website will use the `bleak` theme -and will be rendered differently as shown below. - - - -## Step 7. Update config.toml and live reloading in action - -Restart the server with the `robust` theme, as we will use it in this quickstart. - -```bash -$ hugo server --theme=hugo_theme_robust --buildDrafts -``` - -The website uses the dummy values specified in `bookshelf/config.toml`. -Let's update the configuration. - -```toml -baseURL = "http://example.org/" -languageCode = "en-us" -title = "Shekhar Gulati Book Reviews" - -[Params] - Author = "Shekhar Gulati" -``` - -Hugo has inbuilt support for live reloading. -So, as soon as you save your changes it will apply the change -and reload the web page. You will see the changes shown below. - - - -The same is reflected in the Hugo server logs as well. -As soon as you changed the configuration file, -Hugo applied those changes to the affected pages. - -``` -Config file changed: /Users/shekhargulati/bookshelf/config.toml -1 of 1 draft rendered -0 future content -1 pages created -2 paginator pages created -0 tags created -0 categories created -in 11 ms -``` - -## Step 8. Customize robust theme - -The `robust` theme is a good start towards our online bookshelf but we want to -customize it a bit to meet the look and feel required for the bookshelf. -Hugo makes it very easy to customize themes. -You can also create your themes but we will not do that today. -If you want to create your own theme, then you should refer to -the [Hugo documentation]({{< relref "themes/creation.md" >}}). - -The first change that we have to make is to use a different default image -instead of the one used in the theme. -The theme's default image used in both the list and single view page resides -inside `themes/hugo_theme_robust/static/images/default.jpg`. -We can easily override it by creating a simple directory structure -inside the repository's `static` directory. - -Create an images directory inside the `bookshelf/static` directory -and copy an image with name `default.jpg` inside it. -We will use the default image shown below. - - - -Hugo will sync the changes and reload the website to use new image as shown below. - - - -Now, we need to change the layout of the index page so that only images are shown instead of the text. The index.html inside the layouts directory of the theme refer to partial `li` that renders the list view shown below. - -```html -<article class="li"> - <a href="{{ .Permalink }}" class="clearfix"> - <div class="image" style="background-image: url({{ $.Site.BaseURL }}images/{{ with .Params.image }}{{ . }}{{ else }}default.jpg{{ end }});"></div> - <div class="detail"> - <time>{{ with .Site.Params.DateForm }}{{ $.Date.Format . }}{{ else }}{{ $.Date.Format "Mon, Jan 2, 2006" }}{{ end }}</time> - <h2 class="title">{{ .Title }}</h2> - <div class="summary">{{ .Summary }}</div> - </div> - </a> -</article> -``` - -Create a new file li.html inside the `bookshelf/layouts/_default` directory. Copy the content shown below into the li.html. We have removed details of the book so that only image is shown. - -```html -<article class="li"> - <a href="{{ .Permalink }}" class="clearfix"> - <div class="image" style="background-image: url({{ $.Site.BaseURL }}images/{{ with .Params.image }}{{ . }}{{ else }}default.jpg{{ end }});"></div> - </a> -</article> -``` - -Now, the website will be rendered as shown below. - - - -Next, we want to remove information related to theme from the footer. -So, create a new directory `partials` inside `bookshelf/layouts`. -There, create a new file `default_foot.html` with the content copied -from the theme's `layouts/partials/default_foot.html`. -Replace the footer section with the one shown below. - -```html -<footer class="site"> - <p>{{ with .Site.Copyright | safeHTML }}{{ . }}{{ else }}© {{ $.Site.LastChange.Year }} {{ if isset $.Site.Params "Author" }}{{ $.Site.Params.Author }}{{ else }}{{ .Site.Title }}{{ end }}{{ end }}</p> - <p>Powered by <a href="http://gohugo.io" target="_blank">Hugo</a>,</p> -</footer> -``` - -We also have to remove the sidebar on the right. -Copy the `index.html` from the theme's `layouts` directory to -the `bookshelf/layouts` directory. -Remove the section related to the sidebar from the HTML: - -```html -<div class="col-sm-3"> - {{ partial "sidebar.html" . }} -</div> -``` - -So far we are using the default image but we would like to use the book image so that we can relate to the book. Every book review will define a configuration setting in its front matter. Update the `good-to-great.md` as shown below. - - -``` -+++ -date = "2016-02-14T16:11:58+05:30" -draft = true -title = "Good to Great Book Review" -image = "good-to-great.jpg" -+++ - -I read **Good to Great in January 2016**. An awesome read sharing detailed analysis on how good companies became great. Although this book is about how companies became great but we could apply a lot of the learnings on ourselves. Concepts like level 5 leader, hedgehog concept, the stockdale paradox are equally applicable to individuals. -``` - -Grab a (legal) image from somewhere, name it `good-to-great.jpg`, -and place it in the `bookshelf/static/images` directory. - - -After adding few more books to our shelf, the shelf appears as shown below. -These are a few of the books that I have read within the last year. - - - - -## Step 9. Make posts public - -So far all the posts that we have written are in draft status. -To make a draft public, you can either run a command -or manually change the draft status in the post to `false`. - -```bash -$ hugo undraft content/post/good-to-great.md -``` - -Now, you can start the server without the `buildDrafts` option. - -``` -$ hugo server --theme=hugo_theme_robust -``` - -## Step 10. Integrate Disqus - -Disqus allows you to integrate comments in your static blog. To enable Disqus, you just have to set `disqusShortname` in the config.toml as shown below. - -``` -[Params] - Author = "Shekhar Gulati" - disqusShortname = <your disqus shortname> -``` - -Now, commenting will be enabled in your blog. - - - -## Step 11. Generate website - -To generate Hugo website source you can use -to deploy your website on GitHub pages, -first edit `bookshelf/config.toml`, changing the `baseURL` line to: - -``` -baseURL = "https://<your GitHub username>.github.io/bookshelf/" -``` - -Then type the following command. - -```bash -$ hugo --theme=hugo_theme_robust -``` -``` -0 draft content -0 future content -5 pages created -2 paginator pages created -0 tags created -0 categories created -in 17 ms -``` - -After you run the `hugo` command, a `bookshelf/public` directory -will be created containing the generated website source. - -BTW (in case you tried), -the website isn't properly accessible via the `file:///` protocol. - -## Step 12. Deploy bookshelf on GitHub pages - -Let's version control your bookshelf: - -```bash -$ git init -$ echo "/public/" >> .gitignore -$ echo "/themes/" >> .gitignore -$ git add --all -$ git commit -m "Initial commit" -``` - -Now the Git repositories under `bookshelf/themes` -won't conflict with your `bookshelf` repository, -and neither will a Git repository in `bookshelf/public`. - -Create a new repository on GitHub named `bookshelf` (without a README). -Once that's done, create a new Git repository on your local system -in `bookshelf/public` and add remote: - -```bash -$ cd public -$ git init -$ git remote add origin git@github.com:<github-username>/bookshelf.git -``` - -There, create and check out a new branch `gh-pages`. - -```bash -$ git checkout -b gh-pages -Switched to a new branch 'gh-pages' -``` - -Add all the files (within `bookshelf/public`) to the index, -commit them, and push the changes to GitHub. - -```bash -$ git add --all -$ git commit -m "bookshelf added" -$ git push -f origin gh-pages -``` - -In couple of minutes, your website will be live -at `https://<github-username>.github.io/bookshelf/`. - -Anytime, you can regenerate your site with: - -```bash -$ (cd ..; hugo --theme=hugo_theme_robust) -$ git add --all -$ git commit -m "<some change message>" -$ git push -f origin gh-pages -``` - ----- - -This quickstart was originally written by [Shekhar Gulati](https://twitter.com/shekhargulati) in his [52 Technologies in 2016](https://github.com/shekhargulati/52-technologies-in-2016) blog series. diff --git a/docs/content/overview/source-directory.md b/docs/content/overview/source-directory.md deleted file mode 100644 index 2d4ce10f4..000000000 --- a/docs/content/overview/source-directory.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -aliases: -- /doc/source-directory/ -lastmod: 2015-02-09 -date: 2013-07-01 -menu: - main: - parent: getting started -next: /content/organization -notoc: true -prev: /overview/configuration -title: Source Organization -weight: 50 ---- - -Hugo takes a single directory and uses it as the input for creating a complete -website. - - -The top level of a source directory will typically have the following elements: - - ▸ archetypes/ - ▸ content/ - ▸ data/ - ▸ i18n/ - ▸ layouts/ - ▸ static/ - ▸ themes/ - config.toml - -Learn more about the different directories and what their purpose is: - -* [config]({{< relref "overview/configuration.md" >}}) -* [data]({{< relref "extras/datafiles.md" >}}) -* [i18n]({{< relref "content/multilingual.md#translation-of-strings" >}}) -* [archetypes]({{< relref "content/archetypes.md" >}}) -* [content]({{< relref "content/organization.md" >}}) -* [layouts]({{< relref "templates/overview.md" >}}) -* [static]({{< relref "themes/creation.md#static" >}}) -* [themes]({{< relref "themes/overview.md" >}}) - - -## Example - -An example directory may look like: - - . - ├── config.toml - ├── archetypes - | └── default.md - ├── content - | ├── post - | | ├── firstpost.md - | | └── secondpost.md - | └── quote - | | ├── first.md - | | └── second.md - ├── data - ├── i18n - ├── layouts - | ├── _default - | | ├── single.html - | | └── list.html - | ├── partials - | | ├── header.html - | | └── footer.html - | ├── taxonomy - | | ├── category.html - | | ├── post.html - | | ├── quote.html - | | └── tag.html - | ├── post - | | ├── li.html - | | ├── single.html - | | └── summary.html - | ├── quote - | | ├── li.html - | | ├── single.html - | | └── summary.html - | ├── shortcodes - | | ├── img.html - | | ├── vimeo.html - | | └── youtube.html - | ├── index.html - | └── sitemap.xml - ├── themes - | ├── hyde - | └── doc - └── static - ├── css - └── js - -This directory structure tells us a lot about this site: - -1. The website intends to have two different types of content: *posts* and *quotes*. -2. It will also apply two different taxonomies to that content: *categories* and *tags*. -3. It will be displaying content in 3 different views: a list, a summary and a full page view. - -## Content for home page and other list pages - -Since Hugo 0.18, "everything" is a `Page` that can have content and metadata, like `.Params`, attached to it -- and share the same set of [page variables](/templates/variables/). - -To add content and frontmatter to the home page, a section, a taxonomy or a taxonomy terms listing, add a markdown file with the base name `_index` on the relevant place on the file system. - -For the default Markdown content, the filename will be `_index.md`. - -Se the example directory tree below. - -**Note that you don't have to create `_index` file for every section, taxonomy and similar, a default page will be created if not present, but with no content and default values for `.Title` etc.** - -```bash -└── content - ├── _index.md - ├── categories - │ ├── _index.md - │ └── photo - │ └── _index.md - ├── post - │ ├── _index.md - │ └── firstpost.md - └── tags - ├── _index.md - └── hugo - └── _index.md -``` - diff --git a/docs/content/overview/usage.md b/docs/content/overview/usage.md deleted file mode 100644 index d7c7f7772..000000000 --- a/docs/content/overview/usage.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -aliases: -- /doc/usage/ -lastmod: 2016-08-19 -date: 2013-07-01 -menu: - main: - parent: getting started -next: /overview/configuration -notoc: true -prev: /overview/installing -title: Using Hugo -weight: 30 ---- - -Make sure Hugo is in your `PATH` (or provide a path to it). Test this by: - -{{< nohighlight >}}$ hugo help -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/. - -Usage: - hugo [flags] - hugo [command] - -Available Commands: - benchmark Benchmark Hugo by building a site a number of times. - check Contains some verification checks - config Print the site configuration - convert Convert your content to different formats - env Print Hugo version and environment info - gen A collection of several useful generators. - help Help about any command - import Import your site from others. - list Listing out various types of content - new Create new content for your site - server A high performance webserver - undraft Undraft changes the content's draft status from 'True' to 'False' - version Print the version number of Hugo - -Flags: - -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 - -Use "hugo [command] --help" for more information about a command. -{{< /nohighlight >}} - -## Common Usage Example - -The most common use is probably to run `hugo` with your current directory being the input directory: - -{{< nohighlight >}}$ hugo -0 draft content -0 future content -99 pages created -0 paginator pages created -16 tags created -0 groups created -in 120 ms -{{< /nohighlight >}} - -This generates your web site to the `public/` directory, -ready to be deployed to your web server. - - -## Instant feedback as you develop your web site - -If you are working on things and want to see the changes immediately, by default -Hugo will watch the filesystem for changes, and rebuild your site as soon as a file is saved: - -{{< nohighlight >}}$ hugo -s ~/Code/hugo/docs -0 draft content -0 future content -99 pages created -0 paginator pages created -16 tags created -0 groups created -in 120 ms -Watching for changes in /Users/spf13/Code/hugo/docs/content -Press Ctrl+C to stop -{{< /nohighlight >}} - -Hugo can even run a server and create a site preview at the same time! -Hugo implements [LiveReload](/extras/livereload/) technology to automatically -reload any open pages in all JavaScript-enabled browsers, including mobile. -This is the easiest and most common way to develop a Hugo web site: - -{{< nohighlight >}}$ hugo server -ws ~/Code/hugo/docs -0 draft content -0 future content -99 pages created -0 paginator pages created -16 tags created -0 groups created -in 120 ms -Watching for changes in /Users/spf13/Code/hugo/docs/content -Serving pages from /Users/spf13/Code/hugo/docs/public -Web Server is available at http://localhost:1313/ -Press Ctrl+C to stop -{{< /nohighlight >}} - - -## Deploying your web site - -After running `hugo server` for local web development, -you need to do a final `hugo` run -**without the `server` part of the command** -to rebuild your site. -You may then **deploy your site** by copying the `public/` directory -(by FTP, SFTP, WebDAV, Rsync, `git push`, etc.) -to your production web server. - -Since Hugo generates a static website, your site can be hosted anywhere, -including [Heroku][], [GoDaddy][], [DreamHost][], [GitHub Pages][], -[Amazon S3][] with [CloudFront][], [Firebase Hosting][], -or any other cheap (or even free) static web hosting service. - -[Apache][], [nginx][], [IIS][]... Any web server software would do! - -[Apache]: http://httpd.apache.org/ "Apache HTTP Server" -[nginx]: http://nginx.org/ -[IIS]: http://www.iis.net/ -[Heroku]: https://www.heroku.com/ -[GoDaddy]: https://www.godaddy.com/ -[DreamHost]: http://www.dreamhost.com/ -[GitHub Pages]: https://pages.github.com/ -[GitLab]: https://about.gitlab.com -[Amazon S3]: http://aws.amazon.com/s3/ -[CloudFront]: http://aws.amazon.com/cloudfront/ "Amazon CloudFront" -[Firebase Hosting]: https://firebase.google.com/docs/hosting/ - -### A note about deployment - -Running `hugo` *does not* remove generated files before building. This means that you should delete your `public/` directory (or the directory you specified with `-d`/`--destination`) before running the `hugo` command, or you run the risk of the wrong files (e.g. drafts and/or future posts) being left in the generated site. - -An easy way to work around this is to use different directories for development and production. - -To start a server that builds draft content (helpful for editing), you can specify a different destination: the `dev/` dir. - -{{< nohighlight >}}$ hugo server -wDs ~/Code/hugo/docs -d dev -{{< /nohighlight >}} - -When the content is ready for publishing, use the default `public/` dir: - -{{< nohighlight >}}$ hugo -s ~/Code/hugo/docs -{{< /nohighlight >}} - -This prevents content you're not yet ready to share -from accidentally becoming available. - -### Alternatively, serve your web site with Hugo! - -Yes, that's right! Because Hugo is so blazingly fast both in web site creation -*and* in web serving (thanks to its concurrent and multi-threaded design and -its Go heritage), some users actually prefer using Hugo itself to serve their -web site *on their production server*! - -No other web server software (Apache, nginx, IIS...) is necessary. - -Here is the command: - -{{< nohighlight >}}$ hugo server --baseURL=http://yoursite.org/ \ - --port=80 \ - --appendPort=false \ - --bind=87.245.198.50 -{{< /nohighlight >}} - -Note the `bind` option, -which is the interface to which the server will bind -(defaults to `127.0.0.1`: -fine for most development use cases). -Some hosts, such as Amazon Web Services, -run NAT (network address translation); -sometimes it can be hard to figure out the actual IP address. -Using `--bind=0.0.0.0` will bind to all interfaces. - -This way, you may actually deploy just the source files, -and Hugo on your server will generate the resulting web site -on-the-fly and serve them at the same time. - -You may optionally add `--disableLiveReload=true` if you do not want -the JavaScript code for LiveReload to be added to your web pages. - -Interested? Here are some great tutorials contributed by Hugo users: - -* [hugo, syncthing](http://fredix.xyz/2014/10/hugo-syncthing/) (French) by Frédéric Logier (@fredix) diff --git a/docs/content/release-notes/0.20.3-relnotes.md b/docs/content/release-notes/0.20.3-relnotes.md deleted file mode 100644 index 5ab476ee6..000000000 --- a/docs/content/release-notes/0.20.3-relnotes.md +++ /dev/null @@ -1,23 +0,0 @@ - ---- -date: 2017-04-24 -title: 0.20.3 ---- - - - -This is a bug-fix relase with one important fix. But it also adds some harness around [GoReleaser](https://github.com/goreleaser/goreleaser) to automate the Hugo release process. Big thanks to [@caarlos0](https://github.com/caarlos0) for great and super-fast support fixing issues along the way. - -Hugo now has: - -* 16619+ [stars](https://github.com/gohugoio/hugo/stargazers) -* 458+ [contributors](https://github.com/gohugoio/hugo/graphs/contributors) -* 156+ [themes](http://themes.gohugo.io/) - -## Enhancement - -* Automate the Hugo release process [550eba64](https://github.com/gohugoio/hugo/commit/550eba64705725eb54fdb1042e0fb4dbf6f29fd0) [@bep](https://github.com/bep) [#3358](https://github.com/gohugoio/hugo/issues/3358) - -## Fix - -* Fix handling of zero-length files [9bf5c381](https://github.com/gohugoio/hugo/commit/9bf5c381b6b3e69d4d8dbfd7a40074ac44792bbf) [@bep](https://github.com/bep) [#3355](https://github.com/gohugoio/hugo/issues/3355) diff --git a/docs/content/release-notes/0.20.4-relnotes.md b/docs/content/release-notes/0.20.4-relnotes.md deleted file mode 100644 index 4ddc78c8e..000000000 --- a/docs/content/release-notes/0.20.4-relnotes.md +++ /dev/null @@ -1,28 +0,0 @@ - ---- -date: 2017-04-24T21:12:31+01:00 -title: 0.20.4 ---- - - - -This is the second bug-fix relase of the day, fixing a couple of issues related to the new release scripts. - - -Hugo now has: - -* 16626+ [stars](https://github.com/gohugoio/hugo/stargazers) -* 457+ [contributors](https://github.com/gohugoio/hugo/graphs/contributors) -* 156+ [themes](http://themes.gohugo.io/) - -## Fixes - -* Fix statically linked binaries [275bcf56](https://github.com/gohugoio/hugo/commit/275bcf566c7cb72367d4423cf4810319311ff680) [@munnerz](https://github.com/munnerz) [#3382](https://github.com/gohugoio/hugo/issues/3382) -* Filename change in Hugo 0.20.3 binaries [#3385](https://github.com/gohugoio/hugo/issues/3385) -* Fix version calculation [cb3c6b6f](https://github.com/gohugoio/hugo/commit/cb3c6b6f7670f85189a4a3637e7132901d1ed6e9) [@bep](https://github.com/bep) - - - - - - diff --git a/docs/content/release-notes/0.20.5-relnotes.md b/docs/content/release-notes/0.20.5-relnotes.md deleted file mode 100644 index 4a848169e..000000000 --- a/docs/content/release-notes/0.20.5-relnotes.md +++ /dev/null @@ -1,9 +0,0 @@ - ---- -date: 2017-04-25 -title: 0.20.5 ---- - - - -This is a bug-fix relase which fixes the version number of `0.20.4` (which wrongly shows up as `0.21-DEV`) ([#3388](https://github.com/gohugoio/hugo/issues/3388)).
\ No newline at end of file diff --git a/docs/content/release-notes/0.20.6-relnotes.md b/docs/content/release-notes/0.20.6-relnotes.md deleted file mode 100644 index fe6a2b273..000000000 --- a/docs/content/release-notes/0.20.6-relnotes.md +++ /dev/null @@ -1,26 +0,0 @@ - ---- -date: 2017-04-27 -title: 0.20.6 ---- - - - -There have been some [shouting on discuss.gohugo.io](https://discuss.gohugo.io/t/index-md-is-generated-in-subfolder-index-index-html-hugo-0-20/6338/15) about some broken sites after the release of Hugo `0.20`. This release reintroduces the old behaviour, making `/my-blog-post/index.md` work as expected. - -Hugo now has: - -* 16675+ [stars](https://github.com/gohugoio/hugo/stargazers) -* 456+ [contributors](https://github.com/gohugoio/hugo/graphs/contributors) -* 156+ [themes](http://themes.gohugo.io/) - -## Fixes - -* Avoid index.md in /index/index.html [#3396](https://github.com/gohugoio/hugo/issues/3396) -* Make missing GitInfo a WARNING [b30ca4be](https://github.com/gohugoio/hugo/commit/b30ca4bec811dbc17e9fd05925544db2b75e0e49) [@bep](https://github.com/bep) [#3376](https://github.com/gohugoio/hugo/issues/3376) -* Fix some of the fpm fields for deb [3bd1d057](https://github.com/gohugoio/hugo/commit/3bd1d0571d5f2f6bf0dc8f90a8adf2dbfcb2fdfd) [@anthonyfok](https://github.com/anthonyfok) - - - - - diff --git a/docs/content/release-notes/0.21-relnotes.md b/docs/content/release-notes/0.21-relnotes.md deleted file mode 100644 index 2f393d20f..000000000 --- a/docs/content/release-notes/0.21-relnotes.md +++ /dev/null @@ -1,106 +0,0 @@ - ---- -date: 2017-05-22 -title: 0.21 ---- - - Hugo `0.21` brings full support for shortcodes per [Output Format](https://gohugo.io/extras/output-formats/) ([#3220](https://github.com/gohugoio/hugo/issues/3220)), the last vital piece of that puzzle. This is especially useful for `Google AMP` with its many custom media tags. - -This release represents **126 contributions by 29 contributors** to the main Hugo code base. Since last main release Hugo has **gained 850 stars and 7 additional themes**. - -Hugo now has: - -* 17156+ [stars](https://github.com/gohugoio/hugo/stargazers) -* 457+ [contributors](https://github.com/gohugoio/hugo/graphs/contributors) -* 163+ [themes](http://themes.gohugo.io/) - -[@bep](https://github.com/bep) leads the Hugo development with a significant amount of contributions, but also a big shoutout to [@moorereason](https://github.com/moorereason), [@bogem](https://github.com/bogem), and [@munnerz](https://github.com/munnerz) for their ongoing contributions. And as always a big thanks to [@digitalcraftsman](https://github.com/digitalcraftsman) for his relentless work on keeping the documentation and the themes site in pristine condition. - -## Other Highlights - -On a more technical side, [@moorereason](https://github.com/moorereason) and [@bep](https://github.com/bep) have introduced namespaces for Hugo's many template funcs ([#3042](https://github.com/gohugoio/hugo/issues/3042) ). There are so many now, and adding more into that big pile would be a sure path toward losing control. Now they are nicely categorised into namespaces with its own tests and examples, with an API that the documentation site can use to make sure it is correct and up-to-date. - -## Notes - -* The deprecated `.Extension`, `.Now` and `.TargetPath` will now `ERROR` [544f0a63](https://github.com/gohugoio/hugo/commit/544f0a6394b0e085d355e8217fc5bb3d96c12a98) [@bep](https://github.com/bep) -* The config settings and flags `disable404`, `disableRSS`, `disableSitemap`, `disableRobotsTXT` are now deprecated. Use `disableKinds`. [5794a265](https://github.com/gohugoio/hugo/commit/5794a265b41ffdeebfd8485eecf65cf4088d49d6) [@bep](https://github.com/bep) [#3345](https://github.com/gohugoio/hugo/issues/3345) - -## Enhancements - -### Templates - -* Log a WARNING on wrong usage of `IsSet` [38661c17](https://github.com/gohugoio/hugo/commit/38661c17bb8c31c9f31ee18f8eba5e3bfddd5574) [@moorereason](https://github.com/moorereason) [#3092](https://github.com/gohugoio/hugo/issues/3092) -* Add support for ellipsed paginator navigator, making paginators with lots of pages more compact [b6ea492b](https://github.com/gohugoio/hugo/commit/b6ea492b7a6325d04d44eeb00a990a3a0e29e0c0) [@bep](https://github.com/bep) [#3466](https://github.com/gohugoio/hugo/issues/3466) -* Add support for interfaces to `intersect` [f1c29b01](https://github.com/gohugoio/hugo/commit/f1c29b017bbd88e701cd5151dd186e868672ef89) [@moorereason](https://github.com/moorereason) [#1952](https://github.com/gohugoio/hugo/issues/1952) -* Add `NumFmt` function [93b3b138](https://github.com/gohugoio/hugo/commit/93b3b1386714999d716e03b131f77234248f1724) [@moorereason](https://github.com/moorereason) [#1444](https://github.com/gohugoio/hugo/issues/1444) -* Add template function namespaces [#3418](https://github.com/gohugoio/hugo/issues/3418) [#3042](https://github.com/gohugoio/hugo/issues/3042) [@moorereason](https://github.com/moorereason) [@bep](https://github.com/bep) -* Add translation links to the default sitemap template [90d3fbf1](https://github.com/gohugoio/hugo/commit/90d3fbf1da93a279cfe994a226ae82cf5441deab) [@rayjolt](https://github.com/rayjolt) [#2569](https://github.com/gohugoio/hugo/issues/2569) -* Allow text partials in HTML templates and the other way around [1cf29200](https://github.com/gohugoio/hugo/commit/1cf29200b4bb0a9c006155ec76759b7f4b1ad925) [@bep](https://github.com/bep) [#3273](https://github.com/gohugoio/hugo/issues/3273) - -### Output - -* Refactor site rendering with an "output format context". In this release, this is used for shortcode handling only, but this paves the way for future niceness [1e4d082c](https://github.com/gohugoio/hugo/commit/1e4d082cf5b92fedbc60b1b4f0e9d1ee6ec45e33) [@bep](https://github.com/bep) [#3397](https://github.com/gohugoio/hugo/issues/3397) [2bcbf104](https://github.com/gohugoio/hugo/commit/2bcbf104006e0ec03be4fd500f2519301d460f8c) [@bep](https://github.com/bep) [#3220](https://github.com/gohugoio/hugo/issues/3220) - - -### Core - -* Handle `shortcode` per `Output Format` [af72db80](https://github.com/gohugoio/hugo/commit/af72db806f2c1c0bf1dfe5832275c41eeba89906) [@bep](https://github.com/bep) [#3220](https://github.com/gohugoio/hugo/issues/3220) -* Improve shortcode error message [58d9cbd3](https://github.com/gohugoio/hugo/commit/58d9cbd31bcf7c296a39860fd7e566d10faaff28) [@bep](https://github.com/bep) -* Avoid `index.md` in `/index/index.html` [fea4fd86](https://github.com/gohugoio/hugo/commit/fea4fd86a324bf9679df23f8289887d91b42e919) [@bep](https://github.com/bep) [#3396](https://github.com/gohugoio/hugo/issues/3396) -* Make missing `GitInfo` a `WARNING` [5ad2f176](https://github.com/gohugoio/hugo/commit/5ad2f17693a9860be76ef8089c8728d2b59d6b04) [@bep](https://github.com/bep) [#3376](https://github.com/gohugoio/hugo/issues/3376) -* Prevent decoding `pageParam` in common cases [e98f885b](https://github.com/gohugoio/hugo/commit/e98f885b8af27f5473a89d31d0b1f02e61e8a5ec) [@bogem](https://github.com/bogem) -* Ignore non-source files on partial rebuild [b5b6e81c](https://github.com/gohugoio/hugo/commit/b5b6e81c0269abf9b0f4bc6a127744a25344e5c6) [@xofyarg](https://github.com/xofyarg) [#3325](https://github.com/gohugoio/hugo/issues/3325) -* Log `WARNING` only on unknown `/data` files [ab692e73](https://github.com/gohugoio/hugo/commit/ab692e73dea3ddfe979c88ee236cc394e47e82f1) [@bep](https://github.com/bep) [#3361](https://github.com/gohugoio/hugo/issues/3361) -* Avoid processing the same notify event twice [3b677594](https://github.com/gohugoio/hugo/commit/3b67759495c9268c30e6ba2d8c7e3b75d52d2960) [@bep](https://github.com/bep) -* Only show `rssURI` deprecation `WARNING` if it is actually set [cfd3af8e](https://github.com/gohugoio/hugo/commit/cfd3af8e691119461effa4385251b9d3818e2291) [@bep](https://github.com/bep) [#3319](https://github.com/gohugoio/hugo/issues/3319) - -### Docs - -* Add documentation on slug translation [635b3bb4](https://github.com/gohugoio/hugo/commit/635b3bb4eb873978c7d52e6c0cb85da0c4d25299) [@xavib](https://github.com/xavib) -* Replace `cdn.mathjax.org` with `cdnjs.cloudflare.com` [4b637ac0](https://github.com/gohugoio/hugo/commit/4b637ac041d17b22187f5ccd0f65461f0065aaa9) [@takuti](https://github.com/takuti) -* Add notes about some output format behaviour [162d3a58](https://github.com/gohugoio/hugo/commit/162d3a586d36cabf6376a76b096fd8b6414487ae) [@jpatters](https://github.com/jpatters) -* Add `txtpen` as alternative commenting service [7cdc244a](https://github.com/gohugoio/hugo/commit/7cdc244a72de4c08edc0008e37aec83d945dccdf) [@rickyhan](https://github.com/rickyhan) - -### Other - -* Embed `Page` in `WeightedPage` [ebf677a5](https://github.com/gohugoio/hugo/commit/ebf677a58360126d8b9a1e98d086aa4279f53181) [@bep](https://github.com/bep) [#3435](https://github.com/gohugoio/hugo/issues/3435) -* Improve the detection of untranslated strings [a40d1f6e](https://github.com/gohugoio/hugo/commit/a40d1f6ed2aedddc99725658993258cd557640ed) [@bogem](https://github.com/bogem) [#2607](https://github.com/gohugoio/hugo/issues/2607) -* Make first letter of the Hugo commands flags' usage lowercase [f0f69d03](https://github.com/gohugoio/hugo/commit/f0f69d03c551acb8ac2eeedaad579cf0b596f9ef) [@bogem](https://github.com/bogem) -* Import `Octopress` image tag in `Jekyll importer` [5f3ad1c3](https://github.com/gohugoio/hugo/commit/5f3ad1c31985450fab8d6772e9cbfcb57cf5cc53) [@buynov](https://github.com/buynov) - -## Fixes - -### Templates - -* Do not lower case template names [6d2ea0f7](https://github.com/gohugoio/hugo/commit/6d2ea0f7d7e8a54b8edfc36e52ff74266c30dc27) [@bep](https://github.com/bep) [#3333](https://github.com/gohugoio/hugo/issues/3333) - -### Output - -* Fix output format mixup in example [10287263](https://github.com/gohugoio/hugo/commit/10287263f529181d3169668b044cb84e2e3b049a) [@bep](https://github.com/bep) [#3481](https://github.com/gohugoio/hugo/issues/3481) -* Fix base theme vs project base template logic [077005e5](https://github.com/gohugoio/hugo/commit/077005e514b1ed50d84ceb90c7c72f184cb04521) [@bep](https://github.com/bep) [#3323](https://github.com/gohugoio/hugo/issues/3323) - -### Core -* Render `404` in default language only [154e18dd](https://github.com/gohugoio/hugo/commit/154e18ddb9ad205055d5bd4827c87f3f0daf499f) [@mitchchn](https://github.com/mitchchn) [#3075](https://github.com/gohugoio/hugo/issues/3075) -* Fix `RSSLink` vs `RSS` `Output Format` [e682fcc6](https://github.com/gohugoio/hugo/commit/e682fcc62233b47cf5bdcaf598ac0657ef089471) [@bep](https://github.com/bep) [#3450](https://github.com/gohugoio/hugo/issues/3450) -* Add default config for `ignoreFiles`, making that option work when running in server mode [42f4ce15](https://github.com/gohugoio/hugo/commit/42f4ce15a9d68053da36f9efcf7a7d975cc59559) [@chaseadamsio](https://github.com/chaseadamsio) -* Fix output formats override when no outputs definition given [6e2f2dd8](https://github.com/gohugoio/hugo/commit/6e2f2dd8d3ca61c92a2ee8824fbf05cadef08425) [@bep](https://github.com/bep) [#3447](https://github.com/gohugoio/hugo/issues/3447) -* Fix handling of zero-length files [0e87b18b](https://github.com/gohugoio/hugo/commit/0e87b18b66d2c8ba9e2abc429630cb03f5b093d6) [@bep](https://github.com/bep) [#3355](https://github.com/gohugoio/hugo/issues/3355) -* Must recreate `Paginator` on live-reload [45c74526](https://github.com/gohugoio/hugo/commit/45c74526686f6a2afa02bcee767d837d6b9dd028) [@bep](https://github.com/bep) [#3315](https://github.com/gohugoio/hugo/issues/3315) - -### Docs - -* Fix incorrect path in `templates/list` [27e88154](https://github.com/gohugoio/hugo/commit/27e88154af2dd9af6d0523d6e67b612e6336f91c) [@MunifTanjim](https://github.com/MunifTanjim) -* Fixed incorrect specification of directory structure [a28fbca6](https://github.com/gohugoio/hugo/commit/a28fbca6dcfa80b6541f5ef6c8c12cd1804ae9ed) [@TejasQ](https://github.com/TejasQ) -* Fix `bash` command in `tutorials/github-pages-blog` [c9976155](https://github.com/gohugoio/hugo/commit/c99761555c014e4d041438d5d7e53a6cbaee4492) [@hansott](https://github.com/hansott) -* Fix `.Data.Pages` range in example [b5e32eb6](https://github.com/gohugoio/hugo/commit/b5e32eb60993b4656918af2c959ae217a68c461e) [@hxlnt](https://github.com/hxlnt) - -### Other - -* Fix data race in live-reload close, avoiding some rare panics [355736ec](https://github.com/gohugoio/hugo/commit/355736ec357c81dfb2eb6851ee019d407090c5ec) [@bep](https://github.com/bep) [#2625](https://github.com/gohugoio/hugo/issues/2625) -* Skip `.git` directories in file scan [94b5be67](https://github.com/gohugoio/hugo/commit/94b5be67fc73b87d114d94a7bb1a33ab997f30f1) [@bogem](https://github.com/bogem) [#3468](https://github.com/gohugoio/hugo/issues/3468) - - - - - - diff --git a/docs/content/release-notes/0.22-relnotes.md b/docs/content/release-notes/0.22-relnotes.md deleted file mode 100644 index f5250062e..000000000 --- a/docs/content/release-notes/0.22-relnotes.md +++ /dev/null @@ -1,85 +0,0 @@ - ---- -date: 2017-06-12 -title: 0.22 ---- - - -Hugo `0.22` brings **nested sections**, by popular demand and a long sought after feature ([#465](https://github.com/gohugoio/hugo/issues/465)). We are still low on documentation for this great feature, but [@bep](https://github.com/bep) has been kind enough to accompany his implementation with a [demo site](http://hugotest.bep.is/). - -This release represents **58 contributions by 10 contributors** to the main Hugo code base. Since last release Hugo has **gained 420 stars and 2 additional themes.** - -[@bep](https://github.com/bep) still leads the Hugo development with his witty Norwegian humor, and once again contributed a significant amount of additions. But also a big shoutout to [@bogem](https://github.com/bogem), [@moorereason](https://github.com/moorereason), and [@onedrawingperday](https://github.com/onedrawingperday) for their ongoing contributions. And as always big thanks to [@digitalcraftsman](https://github.com/digitalcraftsman) for his relentless work on keeping the documentation and the themes site in pristine condition. - -Hugo now has: - -* 17576+ [stars](https://github.com/gohugoio/hugo/stargazers) -* 455+ [contributors](https://github.com/gohugoio/hugo/graphs/contributors) -* 165+ [themes](http://themes.gohugo.io/) - -## Other Highlights - -`.Site.GetPage` can now also be used to get regular pages ([#2844](https://github.com/gohugoio/hugo/issues/2844)): - -```go -{{ (.Site.GetPage "page" "blog" "mypost.md" ).Title }} -``` - -Also, considerable work has been put into writing automated benchmark tests for the site builds, and we're happy to report that although this release comes with fundamental structural changes, this version is -- in general -- even faster than the previous. It’s quite a challenge to consistently add significant new functionality and simultaneously maintain the stellar performance Hugo is famous for. - - - -## Notes - -`.Site.Sections` is replaced. We have reworked how sections work in Hugo, they can now be nested and are no longer taxonomies. If you use the old collection, you should get detailed upgrade instructions in the log when you run `hugo`. For more information, see this [demo site](http://hugotest.bep.is/). - -## Enhancements - -### Templates - -* Add `uint` support to `In` [b82cd82f](https://github.com/gohugoio/hugo/commit/b82cd82f1198a371ed94bda7faafe22813f4cb29) [@moorereason](https://github.com/moorereason) -* Support interfaces in `union` [204c3a9e](https://github.com/gohugoio/hugo/commit/204c3a9e32fcf6617ede978e35d3e2e89a5b491c) [@moorereason](https://github.com/moorereason) [#3411](https://github.com/gohugoio/hugo/issues/3411) -* Add `uniq` function [e28d9aa4](https://github.com/gohugoio/hugo/commit/e28d9aa42c3429d22fe254e69e4605aaf1e684f3) [@adiabatic](https://github.com/adiabatic) -* Handle `template.HTML` and friends in `ToInt` [4113693a](https://github.com/gohugoio/hugo/commit/4113693ac1b275f3a40aa5c248269340ef9b57f6) [@moorereason](https://github.com/moorereason) [#3308](https://github.com/gohugoio/hugo/issues/3308) - - -### Core - -* Make the `RSS feed` use the date for the node it represents [f1da5a15](https://github.com/gohugoio/hugo/commit/f1da5a15a37666ee59350d6600a8c14c1383f5bc) [@bep](https://github.com/bep) [#2708](https://github.com/gohugoio/hugo/issues/2708) -* Enable `nested sections` [b3968939](https://github.com/gohugoio/hugo/commit/b39689393ccb8434d9a57658a64b77568c718e99) [@bep](https://github.com/bep) [#465](https://github.com/gohugoio/hugo/issues/465) -* Add test for "no 404" in `sitemap` [8aaec644](https://github.com/gohugoio/hugo/commit/8aaec644a90d09bd7f079d35d382f76bb4ed35db) [@bep](https://github.com/bep) [#3563](https://github.com/gohugoio/hugo/issues/3563) -* Support regular pages in `.Site.GetPage` [e0c2e798](https://github.com/gohugoio/hugo/commit/e0c2e798201f75ae6e9a81a7442355288c2d141b) [@bep](https://github.com/bep) [#2844](https://github.com/gohugoio/hugo/issues/2844) -[#3082](https://github.com/gohugoio/hugo/issues/3082) - -### Performance -* Add site building benchmarks [8930e259](https://github.com/gohugoio/hugo/commit/8930e259d78cba4041b550cc51a7f40bc91d7c20) [@bep](https://github.com/bep) [#3535](https://github.com/gohugoio/hugo/issues/3535) -* Add a cache to `GetPage` which makes it much faster [50d11138](https://github.com/gohugoio/hugo/commit/50d11138f3e18b545c15fadf52f7b0b744bf3e7c) [@bep](https://github.com/bep) -* Speed up `GetPage` [fbb78b89](https://github.com/gohugoio/hugo/commit/fbb78b89df8ccef8f0ab26af00aa45d35c1ee2cf) [@bep](https://github.com/bep) [#3503](https://github.com/gohugoio/hugo/issues/3503) -* Add BenchmarkFrontmatterTags [3d9c4f51](https://github.com/gohugoio/hugo/commit/3d9c4f513b0443648d7e88995e351df1739646d2) [@bep](https://github.com/bep) [#3464](https://github.com/gohugoio/hugo/issues/3464) -* Add `benchSite.sh` to make it easy to run Hugo performance benchmarks [d74452cf](https://github.com/gohugoio/hugo/commit/d74452cfe8f69a85ec83e05481e16bebf199a5cb) [@bep](https://github.com/bep) -* Cache language config [4aff2b6e](https://github.com/gohugoio/hugo/commit/4aff2b6e7409a308f30cff1825fec02991e0d56a) [@bep](https://github.com/bep) -* Temporarily revert to BurntSushi for `TOML` front matter handling; it is currently much faster [0907a5c1](https://github.com/gohugoio/hugo/commit/0907a5c1c293755e6bf297246f07888448d81f8b) [@bep](https://github.com/bep) [#3541](https://github.com/gohugoio/hugo/issues/3541) [#3464](https://github.com/gohugoio/hugo/issues/3464) -* Add a simple partitioned lazy cache [87203139](https://github.com/gohugoio/hugo/commit/87203139c38e0b992c96d7b8a23c7730649c68e5) [@bep](https://github.com/bep) - -### Other - -* Add `noindex` tag to HTML generated by Hugo aliases [d5ab7f08](https://github.com/gohugoio/hugo/commit/d5ab7f087d967b30e7de7d789e6ad3091b42f1f7) [@onedrawingperday](https://github.com/onedrawingperday) -* Update Go versions [bde807bd](https://github.com/gohugoio/hugo/commit/bde807bd1e560fb4cc765c0fc22132db7f8a0801) [@bep](https://github.com/bep) -* Remove the `rlimit` tweaking on `macOS` [bcd32f10](https://github.com/gohugoio/hugo/commit/bcd32f1086c8c604fb22a7496924e41cc46b1605) [@bep](https://github.com/bep) [#3512](https://github.com/gohugoio/hugo/issues/3512) - -### Docs -* Rewrite “Archetypes” article [@davidturnbull](https://github.com/davidturnbull) [#3543](https://github.com/gohugoio/hugo/pull/3543/) -* Remove Unmaintaned Frontends from Tools. [f41f7282](https://github.com/gohugoio/hugo/commit/f41f72822251c9a31031fd5b3dda585c57c8b028) [@onedrawingperday](https://github.com/onedrawingperday) - -## Fixes - -### Core -* Improve `live-reload` on directory structure changes making removal of directories or pasting new content directories into `/content` just work [fe901b81](https://github.com/gohugoio/hugo/commit/fe901b81191860b60e6fcb29f8ebf87baef2ee79) [@bep](https://github.com/bep) [#3570](https://github.com/gohugoio/hugo/issues/3570) -* Respect `disableKinds=["sitemap"]` [69d92dc4](https://github.com/gohugoio/hugo/commit/69d92dc49cb8ab9276ab013d427ba2d9aaf9135d) [@bep](https://github.com/bep) [#3544](https://github.com/gohugoio/hugo/issues/3544) -* Fix `disablePathToLower` regression [5be04486](https://github.com/gohugoio/hugo/commit/5be0448635fdf5fe6b1ee673e869f2b9baf1a5c6) [@bep](https://github.com/bep) [#3374](https://github.com/gohugoio/hugo/issues/3374) -* Fix `ref`/`relref` issue with duplicate base filenames [612f6e3a](https://github.com/gohugoio/hugo/commit/612f6e3afe0510c31f70f3621f3dc8ba609dade4) [@bep](https://github.com/bep) [#2507](https://github.com/gohugoio/hugo/issues/2507) - -### Docs - -* Fix parameter name in `YouTube` shortcode section [37e37877](https://github.com/gohugoio/hugo/commit/37e378773fbc127863f2b7a389d5ce3a14674c73) [@zivbk1](https://github.com/zivbk1) - diff --git a/docs/content/release-notes/0.22.1-relnotes.md b/docs/content/release-notes/0.22.1-relnotes.md deleted file mode 100644 index c0a7dd453..000000000 --- a/docs/content/release-notes/0.22.1-relnotes.md +++ /dev/null @@ -1,40 +0,0 @@ - ---- -date: 2017-06-13 -title: 0.22.1 ---- - - - -Hugo `0.22.1` fixes a couple of issues reported after the [0.22 release](https://github.com/gohugoio/hugo/releases/tag/v0.22) Monday. Most importantly a fix for detecting regular subfolders below the root-sections. - -Also, we forgot to adapt the `permalink settings` with support for nested sections, which made that feature less useful than it could be. - -With this release you can configure **permalinks with sections** like this: - -**First level only:** - -```toml -[permalinks] -blog = ":section/:title" -``` - -**Nested (all levels):** - -```toml -[permalinks] -blog = ":sections/:title" -``` -## Fixes - -* Fix section logic for root folders with subfolders [a30023f5](https://github.com/gohugoio/hugo/commit/a30023f5cbafd06034807255181a5b7b17f3c25f) [@bep](https://github.com/bep) [#3586](https://github.com/gohugoio/hugo/issues/3586) -* Support sub-sections in permalink settings [1f26420d](https://github.com/gohugoio/hugo/commit/1f26420d392a5ab4c7b7fe1911c0268b45d01ab8) [@bep](https://github.com/bep) [#3580](https://github.com/gohugoio/hugo/issues/3580) -* Adjust rlimit to 64000 [ff54b6bd](https://github.com/gohugoio/hugo/commit/ff54b6bddcefab45339d8dc2b13776b92bdc04b9) [@bep](https://github.com/bep) [#3582](https://github.com/gohugoio/hugo/issues/3582) -* Make error on setting rlimit a warning only [629e1439](https://github.com/gohugoio/hugo/commit/629e1439e819a7118ae483381d4634f16d3474dd) [@bep](https://github.com/bep) [#3582](https://github.com/gohugoio/hugo/issues/3582) -* Revert: Remove the rlimit tweaking on macOS" [26aa06a3](https://github.com/gohugoio/hugo/commit/26aa06a3db57ab7134a900d641fa2976f7971520) [@bep](https://github.com/bep) [#3582](https://github.com/gohugoio/hugo/issues/3582) - - - - - - diff --git a/docs/content/release-notes/_index.md b/docs/content/release-notes/_index.md deleted file mode 100644 index 3b934c69d..000000000 --- a/docs/content/release-notes/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -date: 2017-04-17 -aliases: -- /doc/release-notes/ -- /meta/release-notes/ -title: Release Notes -weight: 10 ---- diff --git a/docs/content/release-notes/release-notes.md b/docs/content/release-notes/release-notes.md deleted file mode 100644 index 79ea1594d..000000000 --- a/docs/content/release-notes/release-notes.md +++ /dev/null @@ -1,959 +0,0 @@ ---- -aliases: -- /doc/release-notes/ -- /meta/release-notes/ -date: 2017-04-16 -title: Older Release Notes ---- -# **0.20.2** April 16th 2017 - -Hugo `0.20.2` adds support for plain text partials included into `HTML` templates. This was a side-effect of the big new [Custom Output Format](https://gohugo.io/extras/output-formats/) feature in `0.20`, and while the change was intentional and there was an ongoing discussion about fixing it in {{< gh 3273 >}}, it did break some themes. There were valid workarounds for these themes, but we might as well get it right. - -The most obvious use case for this is inline `CSS` styles, which you now can do without having to name your partials with a `html` suffix. - -A simple example: - -In `layouts/partials/mystyles.css`: - -```css -body { - background-color: {{ .Param "colors.main" }} -} -``` - -Then in `config.toml` (note that by using the `.Param` lookup func, we can override the color in a page's front matter if we want): - -```toml -[params] -[params.colors] -main = "green" -text = "blue" -``` - -And then in `layouts/partials/head.html` (or the partial used to include the head section into your layout): - -```html -<head> - <style type="text/css"> - {{ partial "mystyles.css" . | safeCSS }} - </style> -</head> -``` - -Of course, `0.20` also made it super-easy to create external `CSS` stylesheets based on your site and page configuration. A simple example: - -Add "CSS" to your home page's `outputs` list, create the template `/layouts/index.css` using Go template syntax for the dynamic parts, and then include it into your `HTML` template with: - -```html -{{ with .OutputFormats.Get "css" }} -<link rel="{{ .Rel }}" type="{{ .MediaType.Type }}" href="{{ .Permalink | safeURL }}"> -{{ end }}` -``` - - -# **0.20.1** April 13th 2017 -Hugo `0.20.1` is a bug fix release, fixing some important regressions introduced in `0.20` a couple of days ago: - -* Fix logic for base template in work dir vs in the theme {{< gh 3323 >}} -* camelCased templates (partials, shortcodes etc.) not found {{< gh 3333 >}} -* Live-reload fails with `_index.md` with paginator {{< gh 3315 >}} -* `rssURI` WARNING always shown {{< gh 3319 >}} - -See the [full list](https://github.com/gohugoio/hugo/milestone/16?closed=1). - -# **0.20** April 10th 2017 - -Hugo `0.20` introduces the powerful and long sought after feature [Custom Output Formats]({{< ref "extras/output-formats.md" >}}); Hugo isn't just that "static HTML with an added RSS feed" anymore. *Say hello* to calendars, e-book formats, Google AMP, and JSON search indexes, to name a few ({{< gh 2828 >}}). - -This release represents **over 180 contributions by over 30 contributors** to the main Hugo code base. Since last release Hugo has **gained 1100 stars, 20 new contributors and 5 additional themes.** - -Hugo now has: - -- 16300+ stars -- 495+ contributors -- 156+ themes - -{{< gh "@bep" >}} still leads the Hugo development with his witty Norwegian humor, and once again contributed a significant amount of additions. Also a big shoutout to {{< gh "@digitalcraftsman" >}} for his relentless work on keeping the documentation and the themes site in pristine condition, and {{< gh "@moorereason" >}} and {{< gh "@bogem" >}} for their ongoing contributions. - -## Other Highlights - -{{< gh "@bogem" >}} has also contributed TOML as an alternative and much simpler format for language/i18n files ({{< gh 3200 >}}). A feature you will appreciate when you start to work on larger translations. - -Also, there have been some important updates in the Emacs Org-mode handling: {{< gh "@chaseadamsio" >}} has fixed the newline-handling ({{< gh 3126 >}}) and {{< gh "@clockoon" >}} has added basic footnote support. - -Worth mentioning is also the ongoing work that {{< gh "@rdwatters" >}} and {{< gh "@budparr" >}} is doing to re-do the [gohugo.io](https://gohugo.io/) site, including a total restructuring and partial rewrite of the documentation. It is getting close to finished, and it looks fantastic! - -## Notes -* `RSS` description in the built-in template is changed from full `.Content` to `.Summary`. This is a somewhat breaking change, but is what most people expect from their RSS feeds. If you want full content, please provide your own RSS template. -* The deprecated `.RSSlink` is now removed. Use `.RSSLink`. -* `RSSUri` is deprecated and will be removed in a future Hugo version, replace it with an output format definition. -* The deprecated `.Site.GetParam` is now removed, use `.Site.Param`. -* Hugo does no longer append missing trailing slash to `baseURL` set as a command line parameter, making it consistent with how it behaves from site config. {{< gh 3262 >}} - -## Enhancements - -* Hugo `0.20` is built with Go 1.8.1. -* Add `.Site.Params.mainSections` that defaults to the section with the most pages. Plan is to get themes to use this instead of the hardcoded `blog` in `where` clauses. {{< gh 3206 >}} -* File extension is now configurable. {{< gh 320 >}} -* Impove `markdownify` template function performance. {{< gh 3292 >}} -* Add taxonomy terms' pages to `.Data.Pages` {{< gh 2826 >}} -* Change `RSS` description from full `.Content` to `.Summary`. -* Ignore "." dirs in `hugo --cleanDestinationDir` {{< gh 3202 >}} -* Allow `jekyll import` to accept both `2006-01-02` and `2006-1-2` date format {{< gh 2738 >}} -* Raise the default `rssLimit` {{< gh 3145 >}} -* Unify section list vs single template lookup order {{< gh 3116 >}} -* Allow `apply` to be used with the built-in Go template funcs `print`, `printf` and `println`. {{< gh 3139 >}} - -## Fixes -* Fix deadlock in `getJSON` {{< gh 3211 >}} -* Make sure empty terms pages are created. {{< gh 2977 >}} -* Fix base template lookup order for sections {{< gh 2995 >}} -* `URL` fixes: - * Fix pagination URLs with `baseURL` with sub-root and `canonifyUrls=false` {{< gh 1252 >}} - * Fix pagination URL for resources with "." in name {{< gh 2110 >}} {{< gh 2374 >}} {{< gh 1885 >}} - * Handle taxonomy names with period {{< gh 3169 >}} - * Handle `uglyURLs` ambiguity in `Permalink` {{< gh 3102 >}} - * Fix `Permalink` for language-roots wrong when `uglyURLs` is `true` {{< gh 3179 >}} - * Fix misc case issues for `URLs` {{< gh 1641 >}} - * Fix for taxonomies URLs when `uglyUrls=true` {{< gh 1989 >}} - * Fix empty `RSSLink` for list pages with content page. {{< gh 3131 >}} -* Correctly identify regular pages on the form "my_index_page.md" {{< gh 3234 >}} -* `Exit -1` on `ERROR` in global logger {{< gh 3239 >}} -* Document hugo `help command` {{< gh 2349 >}} -* Fix internal `Hugo` version handling for bug fix releases. {{< gh 3025 >}} -* Only return `RSSLink` for pages that actually have a RSS feed. {{< gh 1302 >}} - - -# **0.19** February 27th 2017 - -We're happy to announce the first release of Hugo in 2017. - -This release represents **over 180 contributions by over 50 contributors** to the main Hugo code base. Since last release Hugo has **gained 1450 stars, 35 new contributors and 15 additional themes.** - -Hugo now has: - -- 15200+ stars -- 470+ contributors -- 151+ themes - -Furthermore, Hugo has its own Twitter account ([@gohugoio](https://twitter.com/gohugoio)) where we share bite-sized news and themes from the Hugo community. - -{{< gh "@bep" >}} leads the Hugo development and once again contributed a significant amount of additions. Also a big shoutout to {{< gh "@chaseadamsio" >}} for the Emacs Org-mode support, {{< gh "@digitalcraftsman" >}} for his relentless work on keeping the documentation and the themes site in pristine condition, {{< gh "@fj" >}}for his work on revising the `params` handling in Hugo, and {{< gh "@moorereason" >}} and {{< gh "@bogem" >}} for their ongoing contributions. - -## Highlights -Hugo `0.19` brings native Emacs Org-mode content support ({{<gh 1483>}}), big thanks to {{< gh "@chaseadamsio" >}}. - -Also, a considerably amount of work have been put into cleaning up the Hugo source code, in an issue titled [Refactor the globals out of site build](https://github.com/gohugoio/hugo/issues/2701). This is not immediately visible to the Hugo end user, but will speed up future development. - -Hugo `0.18` was bringing full-parallel page rendering, so workarounds depending on rendering order did not work anymore, and pages with duplicate target paths (common examples would be `/index.md` or `/about/index.md`) would now conflict with the home page or the section listing. - -With Hugo `0.19`, you can control this behaviour by turning off page types you do not want ({{<gh 2534 >}}). In its most extreme case, if you put the below setting in your `config.toml`, you will get **nothing!**: - -``` -disableKinds = ["page", "home", "section", "taxonomy", "taxonomyTerm", "RSS", "sitemap", "robotsTXT", "404"] -``` -## Other New Features - -* Add ability to sort pages by frontmatter parameters, enabling easy custom "top 10" page lists. {{<gh 3022 >}} -* Add `truncate` template function {{<gh 2882 >}} -* Add `now` function, which replaces the now deprecated `.Now` {{<gh 2859 >}} -* Make RSS item limit configurable {{<gh 3035 >}} - -## Enhancements -* Enhance `.Param` to permit arbitrarily nested parameter references {{<gh 2598 >}} -* Use `Page.Params` more consistently when adding metadata {{<gh 3033 >}} -* The `sectionPagesMenu` feature ("Section menu for the lazy blogger") is now integrated with the section content pages. {{<gh 2974 >}} -* Hugo `0.19` is compiled with Go 1.8! -* Make template funcs like `findRE` and friends more liberal in what argument types they accept {{<gh 3018 >}} {{<gh 2822 >}} -* Improve generation of OpenGraph date tags {{<gh 2979 >}} - -## Notes - -* `sourceRelativeLinks` is now deprecated and will be removed in Hugo `0.21` if no one is stepping up to the plate and fixes and maintains this feature. {{<gh 3028 >}} - -## Fixes -* Fix `.Site.LastChange` on sites where the default sort order is not chronological. {{<gh 2909 >}} -* Fix regression of `.Truncated` evaluation in manual summaries. {{<gh 2989 >}} -* Fix `preserveTaxonomyNames` regression {{<gh 3070 >}} -* Fix issue with taxonomies when only some have content page {{<gh 2992 >}} -* Fix instagram shortcode panic on invalid ID {{<gh 3048 >}} -* Fix subtle data race in `getJSON` {{<gh 3045 >}} -* Fix deadlock in cached partials {{<gh 2935 >}} -* Avoid double-encoding of paginator URLs {{<gh 2177 >}} -* Allow tilde in URLs {{<gh 2177 >}} -* Fix `.Site.Pages` handling on live reloads {{<gh 2869 >}} -* `UniqueID` now correctly uses the fill file path from the content root to calculate the hash, and is finally ... unique! -* Discard current language based on `.Lang()`, go get translations correct for paginated pages. {{<gh 2972 >}} -* Fix infinite loop in template AST handling for recursive templates {{<gh 2927 >}} -* Fix issue with watching when config loading fails {{<gh 2603 >}} -* Correctly flush the imageConfig on live-reload {{<gh 3016 >}} -* Fix parsing of TOML arrays in frontmatter {{<gh 2752 >}} - -## Docs -* Add tutorial "How to use Google Firebase to host a Hugo site" {{<gh 3007 >}} -* Improve documentation for menu rendering {{<gh 3056 >}} -* Revise GitHub Pages deployment tutorial {{<gh 2930 >}} - -# **0.18.1** December 30th 2016 - -Hugo 0.18.1 is a bug fix release fixing some issues introduced in Hugo 0.18: - -* Fix 32-bit binaries {{<gh 2847 >}} -* Fix issues with `preserveTaxonomyNames` {{<gh 2809 >}} -* Fix `.URL` for taxonomy pages when `uglyURLs=true` {{<gh 2819 >}} -* Fix `IsTranslated` and `Translations` for node pages {{<gh 2812 >}} -* Make template error messages more verbose {{<gh 2820 >}} - -# **0.18.0** December 19th 2016 - -Today, we're excited to release the much-anticipated Hugo 0.18! - -We're heading towards the end of the year 2016, and we can look back on three releases and a steady growing community around the project. -This release includes **over 220 contributions by nearly 50 contributors** to the main codebase. -Since the last release, Hugo has **gained 1750 stars and 27 additional themes**. - -Hugo now has: - -- 13750+ stars -- 408+ contributors -- 137+ themes - -{{< gh "@bep" >}} once again took the lead of Hugo and contributed a significant amount of additions. -Also a big shoutout to {{< gh "@digitalcraftsman" >}} for his relentless work on keeping the documentation and the themes site in pristine condition, -and also a big thanks to {{< gh "@moorereason" >}} and {{< gh "@bogem" >}} for their contributions. - -We wish you all a Merry Christmas and a Happy New Year.<br> -*The Hugo team* - -## Highlights - -The primary new feature in Hugo 0.18 is that every piece of content is now a `Page` ({{<gh 2297>}}). -This means that every page, including the home page, can have a content file with frontmatter. -Not only is this a much simpler model to understand, it is also faster and paved the way for several important new features: - -* Enable proper titles for Nodes {{<gh 1051>}} -* Sitemap.xml should include nodes, as well as pages {{<gh 1303>}} -* Document homepage content workaround {{<gh 2240>}} -* Allow home page to be easily authored in markdown {{<gh 720>}} -* Minimalist website with homepage as content {{<gh 330>}} - -Hugo again continues its trend of each release being faster than the last. It's quite a challenge to consistently add significant new functionality and simultaneously dramatically improve performance. Running [this benchmark]( https://github.com/bep/hugo-benchmark) with [these sites](https://github.com/bep/hugo-benchmark/tree/master/sites) (renders to memory) shows about 60% reduction in time spent and 30% reduction in memory usage compared to Hugo 0.17. - -## Other New Features - -* Every `Page` now has a `Kind` property. Since everything is a `Page` now, the `Kind` is used to differentiate different kinds of pages. - Possible values are `page`, `home`, `section`, `taxonomy`, and `taxonomyTerm`. - (Internally, we also define `RSS`, `sitemap`, `robotsTXT`, and `404`, but those have no practical use for end users at the moment since they are not included in any collections.) -* Add a `GitInfo` object to `Page` if `enableGitInfo` is set. It then also sets `Lastmod` for the given `Page` to the author date provided by Git. {{<gh 2291>}} -* Implement support for alias templates {{<gh 2533 >}} -* New template functions: - * Add `imageConfig` function {{<gh 2677>}} - * Add `sha256` function {{<gh 2762>}} - * Add `partialCached` template function {{<gh 1368>}} -* Add shortcode to display Instagram images {{<gh 2690>}} -* Add `noChmod` option to disable perm sync {{<gh 2749>}} -* Add `quiet` build mode {{<gh 1218>}} - -## Notices - -* `.Site.Pages` will now contain *several kinds of pages*, including regular pages, sections, taxonomies, and the home page. - If you want a specific kind of page, you can filter it with `where` and `Kind`. - `.Site.RegularPages` is a shortcut to the page collection you have been used to getting. -* `RSSlink` is now deprecated. Use `RSSLink` instead. - Note that in Hugo 0.17 both of them existed, so there is a fifty-fifty chance you will not have to do anything - (if you use a theme, the chance is close to 0), and `RSSlink` will still work for two Hugo versions. - -## Fixes - -* Revise the `base` template lookup logic so it now better matches the behavior of regular templates, making it easier to override the master templates from the theme {{<gh 2783>}} -* Add workaround for `block` template crash. - Block templates are very useful, but there is a bug in Go 1.6 and 1.7 which makes the template rendering crash if you use the block template in more complex scenarios. - This is fixed in the upcoming Go 1.8, but Hugo adds a temporary workaround in Hugo 0.18. {{<gh 2549>}} -* All the `Params` configurations are now case insensitive {{<gh 1129>}} {{<gh 2590>}} {{<gh 2615>}} -* Make RawContent raw again {{<gh 2601>}} -* Fix archetype title and date handling {{<gh 2750>}} -* Fix TOML archetype parsing in `hugo new` {{<gh 2745>}} -* Fix page sorting when weight is zero {{<gh 2673>}} -* Fix page names that contain dot {{<gh 2555>}} -* Fix RSS Title regression {{<gh 2645>}} -* Handle ToC before handling shortcodes {{<gh 2433>}} -* Only watch relevant themes dir {{<gh 2602>}} -* Hugo new content creates TOML slices with closing bracket on new line {{<gh 2800>}} - - -## Improvements - -* Add page information to error logging in rendering {{<gh 2570>}} -* Deprecate `RSSlink` in favor of `RSSLink` -* Make benchmark command more useful {{<gh 2432>}} -* Consolidate the `Param` methods {{<gh 2590>}} -* Allow to set cache dir in config file -* Performance improvements: - * Avoid repeated Viper loads of `sectionPagesMenu` {{<gh 2728>}} - * Avoid reading from Viper for path and URL funcs {{<gh 2495>}} - * Add `partialCached` template function. This can be a significant performance boost if you have complex partials that does not need to be rerendered for every page. {{<gh 1368>}} - -## Documentation Updates - -* Update roadmap {{<gh 2666>}} -* Update multilingual example {{<gh 2417>}} -* Add a "Deployment with rsync" tutorial page {{<gh 2658>}} -* Refactor `/docs` to use the `block` keyword {{<gh 2226>}} - - -## **0.17.0** October 7th 2016 - -Hugo is going global with our 0.17 release. We put a lot of thought into how we could extend Hugo -to support multilingual websites with the most simple and elegant experience. Hugo's multilingual -capabilities rival the best web and documentation software, but Hugo's experience is unmatched. -If you have a single language website, the simple Hugo experience you already love is unchanged. -Adding additional languages to your website is simple and straightforward. Hugo has been completely -internally rewritten to be multilingual aware with translation and internationalization features -embedded throughout Hugo. - -Hugo continues its trend of each release being faster than the last. It's quite a challenge to consistently add -significant new functionality and simultaneously dramatically improve performance. {{<gh "@bep">}} has made it -his personal mission to apply the Go mantra of "Enable more. Do less" to Hugo. Hugo's consistent improvement -is a testament to his brilliance and his dedication to his craft. Hugo additionally benefits from the -performance improvements from the Go team in the Go 1.7 release. - -This release represents **over 300 contributions by over 70 contributors** to -the main Hugo code base. Since last release Hugo has **gained 2000 stars, 50 new -contributors and 20 additional themes.** - -Hugo now has: - -* 12,000 stars on GitHub -* 370+ contributors -* 110+ themes - -{{<gh "@bep" >}} continues to lead the project with the lionshare of contributions -and reviews. A special thanks to {{<gh "@bep" >}} and {{<gh "@abourget" >}} for their -considerable work on multilingual support. - -A big welcome to newcomers {{<gh "@MarkDBlackwell" >}}, {{<gh "@bogem" >}} and -{{<gh "@g3wanghc" >}} for their critical contributions. - -### Highlights - -**Multilingual Support:** -Hugo now supports multiple languages side-by-side. A single site can now have multiple languages rendered with -full support for translation and i18n. - -**Performance:** -Hugo is faster than ever! Hugo 0.17 is not only our fastest release, it's also the most efficient. -Hugo 0.17 is **nearly twice as fast as Hugo 0.16** and uses about 10% less memory. -This means that the same site will build in nearly half the time it took with Hugo 0.16. -For the first time Hugo sites are averaging well under 1ms per rendered content. - -**Docs overhaul:** -This release really focused on improving the documentation. [Gohugo.io](http://gohugo.io) is -more accurate and complete than ever. - -**Support for macOS Sierra** - -### New Features -* Multilingual support {{<gh 2303>}} -* Allow content expiration {{<gh 2137 >}} -* New templates functions: - * `querify` function to generate query strings inside templates {{<gh 2257>}} - * `htmlEscape` and `htmlUnescape` template functions {{<gh 2287>}} - * `time` converts a timestamp string into a time.Time structure {{<gh 2329>}} - -### Enhancements - -* Render the shortcodes as late as possible {{<gh 0xed0985404db4630d1b9d3ad0b7e41fb186ae0112>}} -* Remove unneeded casts in page.getParam {{<gh 2186 >}} -* Automatic page date fallback {{<gh 2239>}} -* Enable safeHTMLAttr {{<gh 2234>}} -* Add TODO list support for markdown {{<gh 2296>}} -* Make absURL and relURL accept any type {{<gh 2352>}} -* Suppress 'missing static' error {{<gh 2344>}} -* Make summary, wordcount etc. more efficient {{<gh 2378>}} -* Better error reporting in `hugo convert` {{<gh 2440>}} -* Reproducible builds thanks to govendor {{<gh 2461>}} - -### Fixes - -* Fix shortcode in markdown headers {{<gh 2210 >}} -* Explicitly bind livereload to hugo server port {{<gh 2205>}} -* Fix Emojify for certain text patterns {{<gh 2198>}} -* Normalize file name to NFC {{<gh 2259>}} -* Ignore emacs temp files {{<gh 2266>}} -* Handle symlink change event {{<gh 2273>}} -* Fix panic when using URLize {{<gh 2274>}} -* `hugo import jekyll`: Fixed target path location check {{<gh 2293>}} -* Return all errors from casting in templates {{<gh 2356>}} -* Fix paginator counter on x86-32 {{<gh 2420>}} -* Fix half-broken self-closing shortcodes {{<gh 2499>}} - -**** - -## **0.16.0** June 6th 2016 - -Hugo 0.16 is our best and biggest release ever. The Hugo community has -outdone itself with continued performance improvements, -[beautiful themes](http://themes.gohugo.io) for all types of sites from project -sites to documentation to blogs to portfolios, and increased stability. - -This release represents **over 550 contributions by over 110 contributors** to -the main Hugo code base. Since last release Hugo has **gained 3500 stars, 90 -contributors and 23 additional themes.** - -This release celebrates 3 years since {{< gh "@spf13" >}} wrote the first lines -of Hugo. During those 3 years Hugo has accomplished some major milestones -including... - -* 10,000+ stars on GitHub -* 320+ contributors -* 90+ themes -* 1000s of happy websites -* Many subprojects like {{< gh "@spf13/cobra">}}, {{< gh "@spf13/viper">}} and - {{< gh "@spf13/afero">}} which have experienced broad usage across the Go - ecosystem. - -{{< gh "@bep" >}} led the development of Hugo for the 3rd consecutive release -with nearly half of the contributions to 0.16 in addition to his considerable -contributions as lead maintainer. {{< gh "@anthonyfok" >}}, {{< gh -"@DigitalCraftsman" >}}, {{< gh "@MooreReason" >}} all made significant -contributions. A special thanks to {{< gh "@abourget " >}} for his considerable -work on multilingual support. Due to its broad impact we wanted to spend more -time testing it and it will be included in Hugo's next release. - -### Highlights - -**Partial Builds:** Prior to this release Hugo would always reread and rebuild -the entire site. This release introduces support for reactive site building -while watching (`hugo server`). Hugo will watch the filesystem for changes and -only re-read the changed files. Depending on the files change Hugo will -intelligently re-render only the needed portion of the site. Performance gains -depend on the operation performed and size of the site. In our testing build -times decreased anywhere from 10% to 99%. - -**Template Improvements:** Template improvements continue to be a mainstay of each Hugo release. Hugo 0.16 adds support for the new `block` keyword introduced in Go 1.6 -- think base templates with default sections -- as well as many new template functions. - -**Polish:** As Hugo matures releases will inevitably contain fewer huge new features. This release represents hundreds of small improvements across ever facet of Hugo which will make for a much better experience for all of our users. Worth mentioning here is the curious bug where live reloading didn't work in some editors on OS X, including the popular TextMate 2. This is now fixed. Oh, and now any error will exit with an error code, a big thing for automated deployments. - -### New Features -* Support reading configuration variables from the OS environment {{<gh 2090 >}} -* Add emoji support {{<gh 1892>}} -* Add `themesDir` option to configuration {{<gh 1556>}} -* Add support for Go 1.6 `block` keyword in templates {{<gh 1832>}} -* Partial static sync {{<gh 1644>}} -* Source file based relative linking (a la GitHub) {{<gh 0x0f6b334b6715253b030c4e783b88e911b6e53e56>}} -* Add `ByLastmod` sort function to pages. {{<gh 0xeb627ca16de6fb5e8646279edd295a8bf0f72bf1 >}} -* New templates functions: - * `readFile` {{<gh 1551 >}} - * `countwords` and `countrunes` {{<gh 1440>}} - * `default` {{<gh 1943>}} - * `hasPrefix` {{<gh 1243>}} - * `humanize` {{<gh 1818>}} - * `jsonify` {{<gh 0x435e996c4fd48e9009ffa9f83a19fb55f0777dbd>}} - * `md5` and `sha1` {{<gh 1932>}} - * `replaceRE` {{<gh 1845>}} - * `findRE` {{<gh 2048>}} - * `shuffle` {{<gh 1942>}} - * `slice` {{<gh 1902>}} - * `plainify` {{<gh 1915>}} - -### Enhancements - -* Hugo now exits with error code on any error. This is a big thing for - automated deployments. {{<gh 740 >}} -* Print error when `/index.html` is zero-length {{<gh 947>}} -* Enable dirname and filename bash autocompletion for more flags {{<gh - 0x666ddd237791b56fd048992dca9a27d1af50a10e>}} -* Improve error handling in commands {{<gh 1502>}} -* Add sanity checks for `hugo import jekyll` {{<gh 1625 >}} -* Add description to `Page.Params` {{<gh 1484>}} -* Add async version of Google Analytics internal template {{<gh 1711>}} -* Add autostart option to YouTube shortcode {{<gh 1784>}} -* Set Date and Lastmod for main home page {{<gh 1903>}} -* Allow URL with extension in frontmatter {{<gh 1923>}} -* Add list support in Scratch {{<gh - 0xeaba04e82bdfc5d4c29e970f11b4aab9cc0efeaa>}} -* Add file option to gist shortcode {{<gh 1955>}} -* Add config layout and content directory CLI options {{<gh 1698>}} -* Add boolean value comparison to `where` template function {{<gh - 0xf3c74c9db484c8961e70cb3458f9e41e7832fa12>}} -* Do not write to to cache when `ignoreCache` is set {{<gh 2067>}} -* Add option to disable rendering of 404 page {{<gh 2037>}} -* Mercurial is no longer needed to build Hugo {{<gh 2062 >}} -* Do not create `robots.txt` by default {{<gh 2049>}} -* Disable syntax guessing for PygmentsCodeFences by default. To enable syntax - guessing again, add the following to your config file: - `PygmentsCodeFencesGuessSyntax = true` {{<gh 2034>}} -* Make `ByCount` sort consistently {{<gh 1930>}} -* Add `Scratch` to shortcode {{<gh 2000>}} -* Add support for symbolic links for content, layout, static, theme {{<gh 1855 >}} -* Add '+' as one of the valid characters in URLs specified in the front matter - {{<gh 1290 >}} -* Make alias redirect output URLs relative when `RelativeURLs = true` {{<gh 2093 >}} -* Hugo injects meta generator tag on homepage if missing {{<gh 2182 >}} - -### Fixes -* Fix file change watcher for TextMate 2 and friends on OS X {{<gh 1053 >}} -* Make dynamic reloading of config file reliable on all platform {{<gh 1684 >}} -* Hugo now works on Linux/arm64 {{<gh 1772 >}} -* `plainIDAnchors` now defaults to `true` {{<gh 2057>}} -* Win32 and ARM builds fixed {{<gh 1716>}} -* Copy static dir files without theme's static dir {{<gh 1656>}} -* Make `noTimes` command flag work {{<gh 1657>}} -* Change most global CLI flags into local ones {{<gh 1624>}} -* Remove transformation of menu URLs {{<gh 1239>}} -* Do not fail on unknown Jekyll file {{<gh 1705>}} -* Use absolute path when editing with editor {{<gh 1589>}} -* Fix hugo server "Watching for changes" path display {{<gh 1721>}} -* Do not strip special characters out of URLs {{<gh 1292>}} -* Fix `RSSLink` when uglyURLs are enabled {{<gh 175>}} -* Get BaseURL from viper in server mode {{<gh 1821>}} -* Fix shortcode handling in RST {{<gh 1904>}} -* Use default sitemap configuration for homepage {{<gh 1304>}} -* Exit if specific port is unavailable in server mode {{<gh 1901>}} -* Fix regression in "section menus for lazy blogger" {{<gh 2065>}} - -**** - -## **0.15.0** November 25, 2015 - -The v0.15.0 Hugo release brings a lot of polish to Hugo. Exactly 6 months after -the 0.14 release, Hugo has seen massive growth and changes. Most notably, this -is Hugo's first release under the Apache 2.0 license. With this license change -we hope to expand the great community around Hugo and make it easier for our -many users to contribute. This release represents over **377 contributions by -87 contributors** to the main Hugo repo and hundreds of improvements to the -libraries Hugo uses. Hugo also launched a [new theme -showcase](http://themes.gohugo.io) and participated in -[Hacktoberfest](https://hacktoberfest.digitalocean.com). - -Hugo now has: - -* 6700 (+2700) stars on GitHub -* 235 (+75) contributors -* 65 (+30) themes - - -**Template Improvements:** This release takes Hugo to a new level of speed and -usability. Considerable work has been done adding features and performance to -the template system which now has full support of Ace, Amber and Go Templates. - -**Hugo Import:** Have a Jekyll site, but dreaming of porting it to Hugo? This -release introduces a new `hugo import jekyll`command that makes this easier -than ever. - -**Performance Improvements:** Just when you thought Hugo couldn't get any faster, -Hugo continues to improve in speed while adding features. Notably Hugo 0.15 -introduces the ability to render and serve directly from memory resulting in -30%+ lower render times. - -Huge thanks to all who participated in this release. A special thanks to -{{< gh "@bep" >}} who led the development of Hugo this release again, -{{< gh "@anthonyfok" >}}, -{{< gh "@eparis" >}}, -{{< gh "@tatsushid" >}} and -{{< gh "@DigitalCraftsman" >}}. - - -### New features -* new `hugo import jekyll` command. {{< gh 1469 >}} -* The new `Param` convenience method on `Page` and `Node` can be used to get the most specific parameter value for a given key. {{< gh 1462 >}} -* Several new information elements have been added to `Page` and `Node`: - * `RuneCount`: The number of [runes](http://blog.golang.org/strings) in the content, excluding any whitespace. This may be a good alternative to `.WordCount` for Japanese and other CJK languages where a word-split by spaces makes no sense. {{< gh 1266 >}} - * `RawContent`: Raw Markdown as a string. One use case may be of embedding remarkjs.com slides. - * `IsHome`: tells the truth about whether you're on the home page or not. - -### Improvements -* `hugo server` now builds ~30%+ faster by rendering to memory instead of disk. To get the old behavior, start the server with `--renderToDisk=true`. -* Hugo now supports dynamic reloading of the config file when watching. -* We now use a custom-built `LazyFileReader` for reading file contents, which means we don't read media files in `/content` into memory anymore -- and file reading is now performed in parallel on multicore PCs. {{< gh 1181 >}} -* Hugo is now built with `Go 1.5` which, among many other improvements, have fixed the last known data race in Hugo. {{< gh 917 >}} -* Paginator now also supports page groups. {{< gh 1274 >}} -* Markdown improvements: - * Hugo now supports GitHub-flavoured markdown code fences for highlighting for `md`-files (Blackfriday rendered markdown) and `mmark` files (MMark rendered markdown). {{< gh 362 1258 >}} - * Several new Blackfriday options are added: - * Option to disable Blackfriday's `Smartypants`. - * Option for Blackfriday to open links in a new window/tab. {{< gh 1220 >}} - * Option to disable Blackfriday's LaTeX style dashes {{< gh 1231 >}} - * Definition lists extension support. -* `Scratch` now has built-in `map` support. -* We now fall back to `link title` for the default page sort. {{< gh 1299 >}} -* Some notable new configuration options: - * `IgnoreFiles` can be set with a list of Regular Expressions that matches files to be ignored during build. {{< gh 1189 >}} - * `PreserveTaxonomyNames`, when set to `true`, will preserve what you type as the taxonomy name both in the folders created and the taxonomy `key`, but it will be normalized for the URL. {{< gh 1180 >}} -* `hugo gen` can now generate man files, bash auto complete and markdown documentation -* Hugo will now make suggestions when a command is mistyped -* Shortcodes now have a boolean `.IsNamedParams` property. {{< gh 1597 >}} - -### New Template Features -* All template engines: - * The new `dict` function that could be used to pass maps into a template. {{< gh 1463 >}} - * The new `pluralize` and `singularize` template funcs. - * The new `base64Decode` and `base64Encode` template funcs. - * The `sort` template func now accepts field/key chaining arguments and pointer values. {{< gh 1330 >}} - * Several fixes for `slicestr` and `substr`, most importantly, they now have full `utf-8`-support. {{< gh 1190 1333 1347 >}} - * The new `last` template function allows the user to select the last `N` items of a slice. {{< gh 1148 >}} - * The new `after` func allows the user to select the items after the `Nth` item. {{< gh 1200 >}} - * Add `time.Time` type support to the `where`, `ge`, `gt`, `le`, and `lt` template functions. - * It is now possible to use constructs like `where Values ".Param.key" nil` to filter pages that doesn't have a particular parameter. {{< gh 1232 >}} - * `getJSON`/`getCSV`: Add retry on invalid content. {{< gh 1166 >}} - * The new `readDir` func lists local files. {{< gh 1204 >}} - * The new `safeJS` function allows the embedding of content into JavaScript contexts in Go templates. - * Get the main site RSS link from any page by accessing the `.Site.RSSLink` property. {{< gh 1566 >}} -* Ace templates: - * Base templates now also works in themes. {{< gh 1215 >}}. - * And now also on Windows. {{< gh 1178 >}} -* Full support for Amber templates including all template functions. -* A built-in template for Google Analytics. {{< gh 1505 >}} -* Hugo is now shipped with new built-in shortcodes: {{< gh 1576 >}} - * `youtube` for YouTube videos - * `vimeo` for Vimeo videos - * `gist` for GitHub gists - * `tweet` for Twitter Tweets - * `speakerdeck` for Speakerdeck slides - - -### Bugfixes -* Fix data races in page sorting and page reversal. These operations are now also cached. {{< gh 1293 >}} -* `page.HasMenuCurrent()` and `node.HasMenuCurrent()` now work correctly in multi-level nested menus. -* Support `Fish and Chips` style section titles. Previously, this would end up as `Fish And Chips`. Now, the first character is made toupper, but the rest are preserved as-is. {{< gh 1176 >}} -* Hugo now removes superfluous p-tags around shortcodes. {{< gh 1148 >}} - -### Notices -* `hugo server` will watch by default now. -* Some fields and methods were deprecated in `0.14`. These are now removed, so the error message isn't as friendly if you still use the old values. So please change: - * `getJson` to `getJSON`, `getCsv` to `getCSV`, `safeHtml` to - `safeHTML`, `safeCss` to `safeCSS`, `safeUrl` to `safeURL`, `Url` to `URL`, - `UrlPath` to `URLPath`, `BaseUrl` to `BaseURL`, `Recent` to `Pages`. - -### Known Issues - -Using the Hugo v0.15 32-bit Windows or ARM binary, running `hugo server` would crash or hang due to a [memory alignment issue](https://golang.org/pkg/sync/atomic/#pkg-note-BUG) in [Afero](https://github.com/spf13/afero). The bug was discovered shortly after the v0.15.0 release and has since been [fixed](https://github.com/spf13/afero/pull/23) by {{< gh "@tpng" >}}. If you encounter this bug, you may either compile Hugo v0.16-DEV from source, or use the following solution/workaround: - -* **64-bit Windows users: Please use [hugo_0.15_windows_amd64.zip](https://github.com/gohugoio/hugo/releases/download/v0.15/hugo_0.15_windows_amd64.zip)** (amd64 == x86-64). It is only the 32-bit hugo_0.15_windows_386.zip that crashes/hangs (see {{< gh 1621 >}} and {{< gh 1628 >}}). -* **32-bit Windows and ARM users: Please run `hugo server --renderToDisk` as a workaround** until Hugo v0.16 is released (see [“hugo server” returns runtime error on armhf](https://discuss.gohugo.io/t/hugo-server-returns-runtime-error-on-armhf/2293) and {{< gh 1716 >}}). - ----- - -## **0.14.0** May 25, 2015 - -The v0.14.0 Hugo release brings of the most demanded features to Hugo. The -foundation of Hugo is stabilizing nicely and a lot of polish has been added. -We’ve expanded support for additional content types with support for AsciiDoc, -Restructured Text, HTML and Markdown. Some of these types depend on external -libraries as there does not currently exist native support in Go. We’ve tried -to make the experience as seamless as possible. Look for more improvements here -in upcoming releases. - -A lot of work has been done to improve the user experience, with extra polish -to the Windows experience. Hugo errors are more helpful overall and Hugo now -can detect if it’s being run in Windows Explorer and provide additional -instructions to run it via the command prompt. - -The Hugo community continues to grow. Hugo has over 4000 stars on github, 165 -contributors, 35 themes and 1000s of happy users. It is now the 5th most -popular static site generator (by Stars) and has the 3rd largest contributor -community. - -This release represents over **240 contributions by 36 contributors** to the main -Hugo codebase. - -Big shout out to {{< gh "@bep" >}} who led the development of Hugo -this release, {{< gh "@anthonyfok" >}}, -{{< gh "@eparis" >}}, -{{< gh "@SchumacherFM" >}}, -{{< gh "@RickCogley" >}} & -{{< gh "@mdhender" >}} for their significant contributions -and {{< gh "@tatsushid" >}} for his continuous improvements -to the templates. Also a big thanks to all the theme creators. 11 new themes -have been added since last release and the [hugoThemes repo now has previews of -all of -them](https://github.com/gohugoio/hugoThemes/blob/master/README.md#theme-list). - -Hugo also depends on a lot of other great projects. A big thanks to all of our dependencies including: -[cobra](https://github.com/spf13/cobra), -[viper](https://github.com/spf13/viper), -[blackfriday](https://github.com/russross/blackfriday), -[pflag](https://github.com/spf13/pflag), -[HugoThemes](https://github.com/gohugoio/hugothemes), -[BurntSushi](https://github.com/BurntSushi/toml), -[goYaml](https://github.com/go-yaml/yaml/tree/v2), and the Go standard library. - -## New features -* Support for all file types in content directory. - * If dedicated file type handler isn’t found it will be copied to the destination. -* Add `AsciiDoc` support using external helpers. -* Add experimental support for [`Mmark`](https://github.com/miekg/mmark) markdown processor -* Bash autocomplete support via `genautocomplete` command -* Add section menu support for a [Section Menu for "the Lazy Blogger"]({{< relref "extras/menus.md#section-menu-for-the-lazy-blogger" >}}) -* Add support for `Ace` base templates -* Adding `RelativeURLs = true` to site config will now make all the relative URLs relative to the content root. -* New template functions: - * `getenv` - * The string functions `substr` and `slicestr` - * `seq`, a sequence generator very similar to its Gnu counterpart - * `absURL` and `relURL`, both of which takes the `BaseURL` setting into account - -## Improvements -* Highlighting with `Pygments` is now cached to disk -- expect a major speed boost if you use it! -* More Pygments highlighting options, including `line numbers` -* Show help information to Windows users who try to double click on `hugo.exe`. -* Add `bind` flag to `hugo server` to set the interface to which the server will bind -* Add support for `canonifyURLs` in `srcset` -* Add shortcode support for HTML (content) files -* Allow the same `shortcode` to be used with or without inline content -* Configurable RSS output filename - -## Bugfixes -* Fix panic with paginator and zero pages in result set. -* Fix crossrefs on Windows. -* Fix `eq` and `ne` template functions when used with a raw number combined with the result of `add`, `sub` etc. -* Fix paginator with uglyURLs -* Fix {{< gh 998 >}}, supporting UTF8 characters in Permalinks. - -## Notices -* To get variable and function names in line with the rest of the Go community, - a set of variable and function names has been deprecated: These will still - work in 0.14, but will be removed in 0.15. What to do should be obvious by - the build log; `getJson` to `getJSON`, `getCsv` to `getCSV`, `safeHtml` to - `safeHTML`, `safeCss` to `safeCSS`, `safeUrl` to `safeURL`, `Url` to `URL`, - `UrlPath` to `URLPath`, `BaseUrl` to `BaseURL`, `Recent` to `Pages`, - `Indexes` to `Taxonomies`. - - ----- - -## **0.13.0** Feb 21, 2015 - -The v0.13.0 release is the largest Hugo release to date. The release introduced -some long sought after features (pagination, sequencing, data loading, tons of -template improvements) as well as major internal improvements. In addition to -the code changes, the Hugo community has grown significantly and now has over -3000 stars on github, 134 contributors, 24 themes and 1000s of happy users. - -This release represents **448 contributions by 65 contributors** - -A special shout out to {{< gh "@bep" >}} and -{{< gh "@anthonyfok" >}} for their new role as Hugo -maintainers and their tremendous contributions this release. - -### New major features -* Support for [data files](/extras/datafiles/) in [YAML](http://yaml.org/), - [JSON](http://www.json.org/), or [TOML](https://github.com/toml-lang/toml) - located in the `data` directory ({{< gh 885 >}}) -* Support for [dynamic content](/extras/dynamiccontent/) by loading JSON & CSV - from remote sources via GetJson and GetCsv in short codes or other layout - files ({{< gh 748 >}}) -* [Pagination support](/extras/pagination/) for home page, sections and - taxonomies ({{< gh 750 >}}) -* Universal sequencing support - * A new, generic Next/Prev functionality is added to all lists of pages - (sections, taxonomies, etc.) - * Add in-section [Next/Prev](/templates/variables/) content pointers -* `Scratch` -- [a "scratchpad"](/extras/scratch) for your node- and page-scoped - variables -* [Cross Reference](/extras/crossreferences/) support to easily link documents - together with the ref and relref shortcodes. -* [Ace](http://ace.yoss.si/) template engine support ({{< gh 541 >}}) -* A new [shortcode](/extras/shortcodes/) token of `{{</* */>}}` (raw HTML) - alongside the existing `{{%/* */%}}` (Markdown) -* A top level `Hugo` variable (on Page & Node) is added with various build - information -* Several new ways to order and group content: - * `ByPublishDate` - * `GroupByPublishDate(format, order)` - * `GroupByParam(key, order)` - * `GroupByParamDate(key, format, order)` -* Hugo has undergone a major refactoring, with a new handler system and a - generic file system. This sounds and is technical, but will pave the way for - new features and make Hugo even speedier - -### Notable enhancements to existing features - -* The [shortcode](/extras/shortcodes/) handling is rewritten for speed and - better error messages. -* Several improvements to the [template functions](/templates/functions/): - * `where` is now even more powerful and accepts SQL-like syntax with the - operators `==`, `eq`; `!=`, `<>`, `ne`; `>=`, `ge`; `>`, `gt`; `<=`, - `le`; `<`, `lt`; `in`, `not in` - * `where` template function now also accepts dot chaining key argument - (e.g. `"Params.foo.bar"`) -* New template functions: - * `apply` - * `chomp` - * `delimit` - * `sort` - * `markdownify` - * `in` and `intersect` - * `trim` - * `replace` - * `dateFormat` -* Several [configurable improvements related to Markdown - rendering](/overview/configuration/#configure-blackfriday-rendering:a66b35d20295cb764719ac8bd35837ec): - * Configuration of footnote rendering - * Optional support for smart angled quotes, e.g. `"Hugo"` → «Hugo» - * Enable descriptive header IDs -* URLs in XML output is now correctly canonified ({{< gh 725 728 >}}, and part - of {{< gh 789 >}}) - -### Other improvements - -* Internal change to use byte buffer pool significantly lowering memory usage - and providing measurable performance improvements overall -* Changes to docs: - * A new [Troubleshooting](/troubleshooting/overview/) section is added - * It's now searchable through Google Custom Search ({{< gh 753 >}}) - * Some new great tutorials: - * [Automated deployments with - Wercker](/tutorials/automated-deployments/) - * [Creating a new theme](/tutorials/creating-a-new-theme/) -* [`hugo new`](/content/archetypes/) now copies the content in addition to the front matter -* Improved unit test coverage -* Fixed a lot of Windows-related path issues -* Improved error messages for template and rendering errors -* Enabled soft LiveReload of CSS and images ({{< gh 490 >}}) -* Various fixes in RSS feed generation ({{< gh 789 >}}) -* `HasMenuCurrent` and `IsMenuCurrent` is now supported on Nodes -* A bunch of [bug fixes](https://github.com/gohugoio/hugo/commits/master) - ----- - -## **0.12.0** Sept 1, 2014 - -A lot has happened since Hugo v0.11.0 was released. Most of the work has been -focused on polishing the theme engine and adding critical functionality to the -templates. - -This release represents over 90 code commits from 28 different contributors. - - * 10 [new themes](https://github.com/gohugoio/hugoThemes) created by the community - * Fully themable [Partials](/templates/partials/) - * [404 template](/templates/404/) support in themes - * [Shortcode](/extras/shortcodes/) support in themes - * [Views](/templates/views/) support in themes - * Inner [shortcode](/extras/shortcodes/) content now treated as Markdown - * Support for header ids in Markdown (# Header {#myid}) - * [Where](/templates/list/) template function to filter lists of content, taxonomies, etc. - * [GroupBy](/templates/list/) & [GroupByDate](/templates/list/) methods to group pages - * Taxonomy [pages list](/taxonomies/methods/) now sortable, filterable, limitable & groupable - * General cleanup to taxonomies & documentation to make it more clear and consistent - * [Showcase](/showcase/) returned and has been expanded - * Pretty links now always have trailing slashes - * [BaseUrl](/overview/configuration/) can now include a subdirectory - * Better feedback about draft & future post rendering - * A variety of improvements to [the website](http://gohugo.io/) - ----- - -## **0.11.0** May 28, 2014 - -This release represents over 110 code commits from 29 different contributors. - - * Considerably faster... about 3 - 4x faster on average - * [LiveReload](/extras/livereload/). Hugo will automatically reload the browser when the build is complete - * Theme engine w/[Theme Repository](https://github.com/gohugoio/hugoThemes) - * [Menu system](/extras/menus/) with support for active page - * [Builders](/extras/builders/) to quickly create a new site, content or theme - * [XML sitemap](/templates/sitemap/) generation - * [Integrated Disqus](/extras/comments/) support - * Streamlined [template organization](/templates/overview/) - * [Brand new docs site](http://gohugo.io/) - * Support for publishDate which allows for posts to be dated in the future - * More [sort](/content/ordering/) options - * Logging support - * Much better error handling - * More informative verbose output - * Renamed Indexes > [Taxonomies](/taxonomies/overview/) - * Renamed Chrome > [Partials](/templates/partials/) - ----- - -## **0.10.0** March 1, 2014 - -This release represents over 110 code commits from 29 different contributors. - - * [Syntax highlighting](/extras/highlighting/) powered by pygments (**slow**) - * Ability to [sort content](/content/ordering/) many more ways - * Automatic [table of contents](/extras/toc/) generation - * Support for Unicode URLs, aliases and indexes - * Configurable per-section [permalink](/extras/permalinks/) pattern support - * Support for [paired shortcodes](/extras/shortcodes/) - * Shipping with some [shortcodes](/extras/shortcodes/) (highlight & figure) - * Adding [canonify](/extras/urls/) option to keep urls relative - * A bunch of [additional template functions](/layout/functions/) - * Watching very large sites now works on Mac - * RSS generation improved. Limited to 50 items by default, can limit further in [template](/layout/rss/) - * Boolean params now supported in [frontmatter](/content/front-matter/) - * Launched website [showcase](/showcase/). Show off your own hugo site! - * A bunch of [bug fixes](https://github.com/gohugoio/hugo/commits/master) - ----- - -## **0.9.0** November 15, 2013 - -This release represents over 220 code commits from 22 different contributors. - - * New [command based interface](/overview/usage/) similar to git (`hugo server -s ./`) - * Amber template support - * [Aliases](/extras/aliases/) (redirects) - * Support for top level pages (in addition to homepage) - * Complete overhaul of the documentation site - * Full Windows support - * Better index support including [ordering by content weight](/content/ordering/) - * Add params to site config, available in .Site.Params from templates - * Friendlier json support - * Support for html & xml content (with frontmatter support) - * Support for [summary](/content/summaries/) content divider (<code><!--more--></code>) - * HTML in [summary](/content/summaries/) (when using divider) - * Added ["Minutes to Read"](/layout/variables/) functionality - * Support for a custom 404 page - * Cleanup of how content organization is handled - * Loads of unit and performance tests - * Integration with travis ci - * Static directory now watched and copied on any addition or modification - * Support for relative permalinks - * Fixed watching being triggered multiple times for the same event - * Watch now ignores temp files (as created by Vim) - * Configurable number of posts on [homepage](/layout/homepage/) - * [Front matter](/content/front-matter/) supports multiple types (int, string, date, float) - * Indexes can now use a default template - * Addition of truncated bool to content to determine if should show 'more' link - * Support for [linkTitles](/layout/variables/) - * Better handling of most errors with directions on how to resolve - * Support for more date / time formats - * Support for go 1.2 - * Support for `first` in templates - ----- - -## **0.8.0** August 2, 2013 - -This release represents over 65 code commits from 6 different contributors. - - * Added support for pretty urls (filename/index.html vs filename.html) - * Hugo supports a destination directory - * Will efficiently sync content in static to destination directory - * Cleaned up options.. now with support for short and long options - * Added support for TOML - * Added support for YAML - * Added support for Previous & Next - * Added support for indexes for the indexes - * Better Windows compatibility - * Support for series - * Adding verbose output - * Loads of bugfixes - ----- - -## **0.7.0** July 4, 2013 - * Hugo now includes a simple server - * First public release - ----- - -## **0.6.0** July 2, 2013 - * Hugo includes an example documentation site which it builds - ----- - -## **0.5.0** June 25, 2013 - * Hugo is quite usable and able to build spf13.com diff --git a/docs/content/showcase/2626info.md b/docs/content/showcase/2626info.md deleted file mode 100644 index 3797860c0..000000000 --- a/docs/content/showcase/2626info.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: 2016-05-03T17:20:59+09:00 -description: "Personal blog of Masashi Tsuru" -license: "" -licenseLink: "" -sitelink: http://2626.info/ -tags: -- personal -- blog -thumbnail: /img/2626info-tn.png -title: 2626.info ---- - diff --git a/docs/content/showcase/antzucaro.md b/docs/content/showcase/antzucaro.md deleted file mode 100644 index 36ec43245..000000000 --- a/docs/content/showcase/antzucaro.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -lastmod: 2015-01-27 -date: 2014-02-03T20:00:00Z -description: Ant Zucaro's Blog -license: GPL -licenseLink: "" -sitelink: http://antzucaro.com/ -sourceLink: https://github.com/antzucaro/az.com -tags: -- personal -- blog -- foundation -thumbnail: /img/antzucaro-tn.jpg -title: Ant Zucaro ---- - diff --git a/docs/content/showcase/appernetic.md b/docs/content/showcase/appernetic.md deleted file mode 100644 index 53d2d8f77..000000000 --- a/docs/content/showcase/appernetic.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2016-04-26 -date: 2016-04-26T13:33:33Z -description: Appernetic.io blog -license: MIT -licenseLink: https://github.com/appernetic/hugo-bootstrap-premium/blob/master/LICENSE.md -sitelink: https://blog.appernetic.io/ -sourceLink: https://github.com/appernetic/hugo-bootstrap-premium -tags: -- company -- blog -- bootstrap -thumbnail: /img/apperneticioblog.png -title: Appernetic ---- diff --git a/docs/content/showcase/arresteddevops.md b/docs/content/showcase/arresteddevops.md deleted file mode 100644 index b520b5667..000000000 --- a/docs/content/showcase/arresteddevops.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -lastmod: 2015-11-20 -date: 2015-11-20T01:46:33-06:00 -description: "Arrested DevOps is a podcast focusing on trends in the DevOps space" -license: "apache2" -licenseLink: "https://github.com/arresteddevops/ado-hugo/blob/master/LICENSE.md" -sitelink: https://www.arresteddevops.com/ -sourceLink: https://github.com/arresteddevops/ado-hugo -tags: -- podcast -- bootstrap -thumbnail: /img/arresteddevops-tn.png -title: arresteddevops ---- diff --git a/docs/content/showcase/asc.md b/docs/content/showcase/asc.md deleted file mode 100644 index bc9424820..000000000 --- a/docs/content/showcase/asc.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2015-01-27 -date: 2014-01-22T07:32:00Z -description: "" -license: CC-BY-SA -licenseLink: "" -sitelink: http://andrewcodispoti.com/ -sourceLink: https://gitlab.com/acodispo/andrewcodispoti-com -tags: -- personal -- bootstrap -thumbnail: /img/asc-tn.jpg -title: Andrew S Codispoti ---- - diff --git a/docs/content/showcase/astrochili.md b/docs/content/showcase/astrochili.md deleted file mode 100644 index fcf1a4217..000000000 --- a/docs/content/showcase/astrochili.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -date: 2016-07-31T11:22:32+03:00 -description: "Personal website" -license: "" -licenseLink: "" -sitelink: http://romansilin.com/ -sourceLink: https://github.com/astrochili/astrochili.github.io -tags: -- personal -- blog -thumbnail: /img/astrochili-tn.png -title: Roman Silin ---- - diff --git a/docs/content/showcase/aydoscom.md b/docs/content/showcase/aydoscom.md deleted file mode 100644 index 3239d4467..000000000 --- a/docs/content/showcase/aydoscom.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -date: 2016-04-23T13:23:00Z -description: "web applications" -license: "" -licenseLink: "" -sitelink: https://aydos.com/ -tags: -- web applications -thumbnail: /img/aydoscom.png -title: aydos.com ---- - diff --git a/docs/content/showcase/balaramadurai.net.md b/docs/content/showcase/balaramadurai.net.md deleted file mode 100644 index ca4a7c71e..000000000 --- a/docs/content/showcase/balaramadurai.net.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -date: 2016-11-17T12:27:18+05:30 -description: "Dr. Bala Ramadurai, Professor & Consultant in Innovation, Design Thinking and Tech Forecasting" -license: "" -licenseLink: "" -sitelink: http://balaramadurai.net -tags: -- personal -- blog -thumbnail: /img/balaramadurai-net-tn.jpg -title: Dr. Bala Ramadurai | Professor & Consultant in Innovation, Design Thinking and Tech Forecasting ---- diff --git a/docs/content/showcase/barricade.md b/docs/content/showcase/barricade.md deleted file mode 100644 index 6316e085a..000000000 --- a/docs/content/showcase/barricade.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: 2016-04-15T14:14:28+01:00 -description: "Barricade is an early warning system against hackers." -license: "" -licenseLink: "" -sitelink: https://barricade.io -tags: -- company -- security -thumbnail: /img/barricade-tn.png -title: Barricade ---- - diff --git a/docs/content/showcase/bepsays.md b/docs/content/showcase/bepsays.md deleted file mode 100644 index c6c749f11..000000000 --- a/docs/content/showcase/bepsays.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2015-05-26 -date: 2013-11-01T07:32:00Z -description: "bep's blog" -license: "" -licenseLink: "" -sitelink: http://bepsays.com/ -sourceLink: "https://github.com/bep/bepsays.com" -tags: -- personal -- blog -thumbnail: /img/bepsays-tn.png -title: bepsays.com ---- - diff --git a/docs/content/showcase/bharathpalavalli.com.md b/docs/content/showcase/bharathpalavalli.com.md deleted file mode 100644 index 79d60dcf3..000000000 --- a/docs/content/showcase/bharathpalavalli.com.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -date: 2017-03-15T07:32:00Z -description: "Bharath M. Palavalli" -license: "" -licenseLink: "" -sitelink: http://bharathpalavalli.com -sourceLink: https://github.com/bmp/bharathmp-hugo/tree/gh-pages -tags: -- personal -- website -thumbnail: /img/bharathpalavalli-tn.png -title: bharathpalavalli.com ---- - diff --git a/docs/content/showcase/bugtrackers.io.md b/docs/content/showcase/bugtrackers.io.md deleted file mode 100644 index d3a61489c..000000000 --- a/docs/content/showcase/bugtrackers.io.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -lastmod: 2015-10-27 -date: 2015-10-27T09:02:00Z -description: bugtrackers.io provides stories of digital crafters. It shows people behind bits, pixels and bug reports. bugtrackers.io is your resource for web development. -sitelink: https://www.bugtrackers.io/ -tags: -- blog -- community -- interviews -thumbnail: /img/bugtrackersio-tn.jpg -title: bugtrackers.io ---- - diff --git a/docs/content/showcase/bullion-investor.md b/docs/content/showcase/bullion-investor.md deleted file mode 100644 index 262dcfb53..000000000 --- a/docs/content/showcase/bullion-investor.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -date: 2017-02-11T10:30:00+02:00 -description: "German language GOLD REPORT. Tips, tricks, news & glossary on coins, bullion bars and precious-metals investments." -sitelink: https://www.bullion-investor.com/report/ -tags: -- 'gold price' -- blog -- coins -- deutschland -- finance -- germany -- gold -- investment -- news -- numismatics -- palladium -- platinum -- report -- silver -thumbnail: /img/bullion-investor-com.png -title: GOLDREPORT — Gold, Silver & Numismatics News ----
\ No newline at end of file diff --git a/docs/content/showcase/camunda-blog.md b/docs/content/showcase/camunda-blog.md deleted file mode 100644 index 7e7f76427..000000000 --- a/docs/content/showcase/camunda-blog.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2015-11-30 -date: 2015-12-01T04:20:00Z -description: "Camunda BPM Team Blog" -license: "Apache 2.0" -licenseLink: "https://github.com/camunda/blog.camunda.org#license" -sitelink: http://blog.camunda.org/ -sourceLink: https://github.com/camunda/blog.camunda.org -tags: -- company -- blog -thumbnail: /img/camunda-blog.png -title: Camunda Blog ---- - diff --git a/docs/content/showcase/camunda-docs.md b/docs/content/showcase/camunda-docs.md deleted file mode 100644 index 8d97d1492..000000000 --- a/docs/content/showcase/camunda-docs.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2015-11-30 -date: 2015-12-01T04:20:00Z -description: "Camunda BPM Documentation" -license: MIT -licenseLink: "https://github.com/camunda/camunda-docs-theme#licence" -sitelink: http://docs.camunda.org/ -sourceLink: https://github.com/camunda/camunda-docs-theme -tags: -- company -- documentation -thumbnail: /img/camunda-docs.png -title: Camunda Docs ---- - diff --git a/docs/content/showcase/carnivorousplants.md b/docs/content/showcase/carnivorousplants.md deleted file mode 100644 index 30f3b3756..000000000 --- a/docs/content/showcase/carnivorousplants.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: 2017-05-13T11:00:00Z -description: "Tools, guides, and interactive resources for growers of all carnivorous plant species." -license: "" -licenseLink: "" -sitelink: https://www.carnivorousplants.co.uk/ -tags: -- blog -- education -thumbnail: /img/carnivorousplants-tn.png -title: CarnivorousPlants.co.uk ---- - diff --git a/docs/content/showcase/cdnoverview.md b/docs/content/showcase/cdnoverview.md deleted file mode 100644 index d48788ec6..000000000 --- a/docs/content/showcase/cdnoverview.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -date: 2016-02-17T15:19:08+01:00 -description: "Overview and comparison of CDNs, their features and prices" -license: "" -licenseLink: "" -sitelink: https://www.cdnoverview.com/ -tags: -- bootstrap -- portfolio -- tech -thumbnail: /img/cdnoverview-tn.png -title: cdnoverview.com ---- - diff --git a/docs/content/showcase/chinese-grammar.md b/docs/content/showcase/chinese-grammar.md deleted file mode 100644 index 3e8bc3563..000000000 --- a/docs/content/showcase/chinese-grammar.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -lastmod: 2015-08-21 -date: 2015-08-23 -description: Chinese grammar lessons -sitelink: https://www.chineseboost.com/grammar/ -sourceLink: https://github.com/hughgrigg/chineseboost-articles -tags: -- learning -- education -thumbnail: /img/chinese-grammar-tn.png -title: Chinese Grammar ---- diff --git a/docs/content/showcase/chingli.md b/docs/content/showcase/chingli.md deleted file mode 100644 index ae2d4a4db..000000000 --- a/docs/content/showcase/chingli.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -lastmod: 2015-12-19 -date: 2014-08-26T11:20:02-04:00 -description: "chingli’s personal blog" -sitelink: http://www.chingli.com/ -tags: -- personal -- blog -thumbnail: /img/chingli-tn.jpg -title: <span lang="zh-CN">青砾</span> (chingli) ---- - diff --git a/docs/content/showcase/chipsncookies.md b/docs/content/showcase/chipsncookies.md deleted file mode 100644 index ff3128d81..000000000 --- a/docs/content/showcase/chipsncookies.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2016-04-14 -date: 2015-07-08T14:02:16+02:00 -description: "personal blog and portfolio of Samuel Debruyn" -license: "" -licenseLink: "" -sitelink: https://chipsncookies.com -sourceLink: https://github.com/SamuelDebruyn/chipsncookies-site -tags: -- personal -- blog -thumbnail: /img/chipsncookies-tn.png -title: Chips 'n' Cookies ---- - diff --git a/docs/content/showcase/christianmendoza.md b/docs/content/showcase/christianmendoza.md deleted file mode 100644 index 6d18735d9..000000000 --- a/docs/content/showcase/christianmendoza.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -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/ -sourceLink: https://github.com/christianmendoza/christianmendoza.me -tags: -- personal -- profile -thumbnail: /img/christianmendoza-tn.jpg -title: christianmendoza.me ---- diff --git a/docs/content/showcase/cinegyopen.md b/docs/content/showcase/cinegyopen.md deleted file mode 100644 index 592df2612..000000000 --- a/docs/content/showcase/cinegyopen.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -date: 2016-09-05T23:23:18+02:00 -description: "Cinegy Open documentation project" -license: "" -licenseLink: "" -sitelink: https://open.cinegy.com/ -sourceLink: -tags: -- documentation -thumbnail: /img/cinegyopen-tn.png -title: Cinegy Open ----
\ No newline at end of file diff --git a/docs/content/showcase/clearhaus.md b/docs/content/showcase/clearhaus.md deleted file mode 100644 index 9408ec8e6..000000000 --- a/docs/content/showcase/clearhaus.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -date: 2016-10-21T12:37:00+02:00 -description: "Online Acquiring · Accept Visa & MasterCard within 1-3 days" -license: "" -licenseLink: "" -sitelink: https://www.clearhaus.com/ -tags: - - company - - fintech - - payments - - acquirer -thumbnail: /img/clearhaus-tn.png -title: Clearhaus ---- diff --git a/docs/content/showcase/cloudshark.md b/docs/content/showcase/cloudshark.md deleted file mode 100644 index 6a8b3fa4f..000000000 --- a/docs/content/showcase/cloudshark.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2015-01-27 -date: 2014-03-27T09:45:00Z -description: CloudShark Appliance homepage and documentation -license: "" -licenseLink: "" -sitelink: https://appliance.cloudshark.org/ -tags: -- company -- documentation -- foundation -thumbnail: /img/cloudshark-tn.jpg -title: CloudShark ---- - diff --git a/docs/content/showcase/coding-journal.md b/docs/content/showcase/coding-journal.md deleted file mode 100644 index 78e4b38d2..000000000 --- a/docs/content/showcase/coding-journal.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -lastmod: 2015-12-23 -date: 2015-12-23T11:42:00+01:00 -description: blog, portfolio -license: "" -licenseLink: "" -sitelink: http://blog.kulman.sk/ -sourceLink: https://github.com/igorkulman/coding-journal -tags: -- blog -- portfolio -thumbnail: /img/codingjournal-tn.png -title: Coding Journal ---- diff --git a/docs/content/showcase/consequently.md b/docs/content/showcase/consequently.md deleted file mode 100644 index 3469129f9..000000000 --- a/docs/content/showcase/consequently.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -lastmod: 2015-02-11 -date: 2015-02-11T13:21:27+11:00 -description: "consequently.org, Greg Restall's personal website" -license: "" -licenseLink: "" -sitelink: http://consequently.org -sourceLink: "https://github.com/consequently/consequently-hugo" -tags: -- academic -- blog -- kube -thumbnail: /img/consequently.jpg -title: consequently.org ---- - diff --git a/docs/content/showcase/ctlcompiled.md b/docs/content/showcase/ctlcompiled.md deleted file mode 100644 index 18179cf5b..000000000 --- a/docs/content/showcase/ctlcompiled.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -date: 2016-07-25T13:45:09-04:00 -description: "CompilED is a collection of reflections and comments by the software developers at Columbia’s Center for Teaching and Learning (CTL). These views are rooted in our professional and personal experiences developing educational technology." -license: "Creative Commons Attribution-ShareAlike 3.0 United States." -licenseLink: "https://creativecommons.org/licenses/by-sa/3.0/us/" -sitelink: https://compiled.ctl.columbia.edu/ -tags: -- edtech -- technology -- blog -thumbnail: /img/ctlcompiled-tn.png -title: CompilED at CTL ---- - diff --git a/docs/content/showcase/danmux.md b/docs/content/showcase/danmux.md deleted file mode 100644 index 1ae4589d1..000000000 --- a/docs/content/showcase/danmux.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2014-08-26 -date: 2014-08-26T10:55:23-04:00 -description: "" -license: MIT -licenseLink: "" -sitelink: http://danmux.com/ -sourceLink: https://github.com/danmux/danmux-hugo -tags: -- personal -- blog -thumbnail: /img/danmux-tn.jpg -title: Danmux ---- - diff --git a/docs/content/showcase/datapipelinearchitect.md b/docs/content/showcase/datapipelinearchitect.md deleted file mode 100644 index a74eb835e..000000000 --- a/docs/content/showcase/datapipelinearchitect.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: 2016-02-04T18:30:07-05:00 -description: "Professional website at datapipelinearchitect.com" -sitelink: http://datapipelinearchitect.com/ -tags: -- company -- tech -- blog -- website -thumbnail: /img/datapipelinearchitect-tn.jpg -title: Data Pipeline Architect ---- - diff --git a/docs/content/showcase/davidepetilli.md b/docs/content/showcase/davidepetilli.md deleted file mode 100644 index 6b69eee0f..000000000 --- a/docs/content/showcase/davidepetilli.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -lastmod: 2015-05-25 -date: 2013-11-01T07:32:00Z -description: "" -license: MIT -licenseLink: "" -sitelink: http://davidepetilli.com -tags: -- personal -- photography -- portfolio -- blog -thumbnail: /img/davidepetilli-tn.jpg -title: Davide Petilli ---- - diff --git a/docs/content/showcase/davidrallen.md b/docs/content/showcase/davidrallen.md deleted file mode 100644 index 06e802fd5..000000000 --- a/docs/content/showcase/davidrallen.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -date: 2016-02-03T11:49:07-05:00 -description: "Personal website for David Allen" -license: "MIT" -licenseLink: "https://opensource.org/licenses/MIT" -sitelink: http://davidrallen.com/ -sourceLink: https://github.com/doctorallen/davidrallen.com -tags: -- personal -- blog -- tech -thumbnail: /img/davidrallen-tn.png -title: David Allen ---- - diff --git a/docs/content/showcase/davidyates.md b/docs/content/showcase/davidyates.md deleted file mode 100644 index 0d6063ad4..000000000 --- a/docs/content/showcase/davidyates.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: 2016-09-10T07:07:39+02:00 -description: "David Yates" -license: "" -licenseLink: "" -sitelink: https://davidyat.es/ -tags: -- personal -- blog -thumbnail: /img/davidyates-tn.png -title: David Yates ---- - diff --git a/docs/content/showcase/dbzman-online.md b/docs/content/showcase/dbzman-online.md deleted file mode 100644 index f30d71491..000000000 --- a/docs/content/showcase/dbzman-online.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -date: 2017-01-02T07:32:00Z -description: "" -license: "" -licenseLink: "" -sitelink: http://dbzman-online.eu/ -sourceLink: https://github.com/Dbzman/dbzman-online.eu -tags: -- personal -- blog -- portfolio -thumbnail: /img/dbzman-online-tn.png -title: Dbzman-Online ---- - diff --git a/docs/content/showcase/devmonk.md b/docs/content/showcase/devmonk.md deleted file mode 100644 index 00a1a7572..000000000 --- a/docs/content/showcase/devmonk.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2014-08-26 -date: 2014-08-26T11:31:02-04:00 -description: "" -license: "" -licenseLink: "" -sitelink: https://devmonk.com/ -sourceLink: https://github.com/peteraba/devmonk.com -tags: -- educational -- video -thumbnail: /img/devmonk-tn.jpg -title: devmonk ---- - diff --git a/docs/content/showcase/dmitriid.com.md b/docs/content/showcase/dmitriid.com.md deleted file mode 100644 index 2a5e308ba..000000000 --- a/docs/content/showcase/dmitriid.com.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -date: 2016-10-19T16:52:28+02:00 -description: "Personal blog" -license: "CC BY-NC 4.0" -licenseLink: "" -sitelink: http://dmitriid.com/ -sourceLink: https://github.com/dmitriid/dmitriid.com -tags: -- personal -- blog -thumbnail: /img/dmitriid.com.png -title: dmitriid.com ---- - diff --git a/docs/content/showcase/emilyhorsman.com.md b/docs/content/showcase/emilyhorsman.com.md deleted file mode 100644 index 8e792f716..000000000 --- a/docs/content/showcase/emilyhorsman.com.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -lastmod: 2016-01-09 -date: 2016-01-09T01:00:10Z -description: Personal homepage -sitelink: https://emilyhorsman.com/ -sourceLink: https://github.com/emilyhorsman/buttercup -tags: -- personal -- blog -thumbnail: /img/emilyhorsman.com-tn.jpg -title: emilyhorsman.com ---- - diff --git a/docs/content/showcase/enjoyablerecipes.md b/docs/content/showcase/enjoyablerecipes.md deleted file mode 100644 index 7b97e6293..000000000 --- a/docs/content/showcase/enjoyablerecipes.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -date: 2017-03-07T07:32:00Z -description: "Indian Recipes Blog" -license: "" -licenseLink: "" -sitelink: https://enjoyable.recipes/ -sourceLink: https://github.com/shubhojyoti/enjoyablerecipes-hugo -tags: -- personal -- blog -- recipes -- zurb-foundation -thumbnail: /img/enjoyablerecipes-tn.png -title: Enjoyable Recipes ---- - diff --git a/docs/content/showcase/esaezgil.md b/docs/content/showcase/esaezgil.md deleted file mode 100644 index f1ae53b20..000000000 --- a/docs/content/showcase/esaezgil.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -date: 2017-04-02T07:32:00Z -description: "Personal blog of Enrique Saez Gil - esaezgil" -license: "" -licenseLink: "" -sitelink: https://esaezgil.com -sourceLink: https://github.com/esaezgil/esaezgil.github.io -tags: -- personal -- technical blog -- software -- open source -thumbnail: /img/esaezgil_com-tn.png -title: esaezgil.com ---- - diff --git a/docs/content/showcase/esolia-com.md b/docs/content/showcase/esolia-com.md deleted file mode 100644 index 58a482f51..000000000 --- a/docs/content/showcase/esolia-com.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -lastmod: 2015-08-08 -date: 2015-07-07T04:32:00Z -description: Tokyo IT service provider eSolia Inc's Hugo-powered website. -license: MIT -licenseLink: "" -sitelink: http://esolia.com/ -sourceLink: https://github.com/eSolia/eSolia -tags: -- company -- esolia -- rickcogley -- japan -thumbnail: /img/esolia_com-tn.png -title: eSolia.com ---- diff --git a/docs/content/showcase/esolia-pro.md b/docs/content/showcase/esolia-pro.md deleted file mode 100644 index 24b06b1f8..000000000 --- a/docs/content/showcase/esolia-pro.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -lastmod: 2015-08-08 -date: 2015-07-07T04:32:00Z -description: Tokyo IT service provider eSolia Inc's eSolia.pro blog site, powered by Hugo. -license: MIT -licenseLink: "" -sitelink: http://esolia.pro/ -sourceLink: https://github.com/eSolia/eSolia.pro -tags: -- company -- esolia -- rickcogley -- japan -thumbnail: /img/esolia_pro-tn.png -title: eSolia.pro ---- diff --git a/docs/content/showcase/eurie.md b/docs/content/showcase/eurie.md deleted file mode 100644 index 0ab5966f7..000000000 --- a/docs/content/showcase/eurie.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -date: 2016-10-15T23:30:59+09:00 -description: "User guide for euire Desk" -license: "" -licenseLink: "" -sitelink: https://docs.eurie.io -tags: -- documentation -thumbnail: /img/docs.eurie.io-tn.png -title: eurie Desk docs ---- diff --git a/docs/content/showcase/fale.md b/docs/content/showcase/fale.md deleted file mode 100644 index 449c1cc22..000000000 --- a/docs/content/showcase/fale.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2016-03-01 -date: 2016-03-01T12:38:00Z -description: Fabio Alessandro Locati personal blog. -license: AGPLv3 -licenseLink: "" -sitelink: http://fale.io/ -sourceLink: https://github.com/fale/fale.io -tags: -- personal -- blog -thumbnail: /img/fale-tn.png -title: fale.io ---- - diff --git a/docs/content/showcase/firstnameclub.md b/docs/content/showcase/firstnameclub.md deleted file mode 100644 index 573cdda0a..000000000 --- a/docs/content/showcase/firstnameclub.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: 2017-03-31T22:36:12+03:00 -description: "Multilingual website. Size 20GB, build time 25 mins. Cloudflare, s3, bootstrap 4" -license: "" -licenseLink: "" -sitelink: https://firstname.club -sourceLink: -tags: -- data -- website -thumbnail: /img/firstnameclub.png -title: firstname club ---- diff --git a/docs/content/showcase/fixatom.md b/docs/content/showcase/fixatom.md deleted file mode 100644 index 8ba1978d1..000000000 --- a/docs/content/showcase/fixatom.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: 2016-10-17T16:19:24+08:00 -description: "a personal blog" -license: "" -licenseLink: "" -sitelink: https://fixatom.com/ -tags: -- personal -- blog -thumbnail: /img/fixatom-tn.png -title: Atom ---- - diff --git a/docs/content/showcase/furqansoftware.md b/docs/content/showcase/furqansoftware.md deleted file mode 100644 index 4d377e642..000000000 --- a/docs/content/showcase/furqansoftware.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -date: 2017-05-24T06:19:40Z -description: "Official company website" -sitelink: https://furqansoftware.com/ -tags: -- company -- website -- blog -- tech -thumbnail: /img/furqansoftware-tn.png -title: Furqan Software ---- diff --git a/docs/content/showcase/fxsitecompat.md b/docs/content/showcase/fxsitecompat.md deleted file mode 100644 index 393b097d9..000000000 --- a/docs/content/showcase/fxsitecompat.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -lastmod: 2015-09-08 -date: 2014-08-26T19:40:00-04:00 -description: Multilingual, community documentation and blog site -license: "" -licenseLink: "" -sitelink: https://www.fxsitecompat.com/ -sourceLink: https://github.com/fxsitecompat/www.fxsitecompat.com -tags: -- community -- documentation -- translation -thumbnail: /img/fxsitecompat-tn.png -title: Firefox Site Compatibility ---- - diff --git a/docs/content/showcase/gntech.md b/docs/content/showcase/gntech.md deleted file mode 100644 index 3d199e931..000000000 --- a/docs/content/showcase/gntech.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -date: 2016-02-13T21:47:27+01:00 -description: "Projects, music and drawings, the personal web page of Gustav Näslund" -license: "" -licenseLink: "" -sitelink: http://www.gntech.se/ -tags: -- personal -- blog -- projects -- music -- drawings -thumbnail: /img/gntech-tn.png -title: gntech.se ---- diff --git a/docs/content/showcase/gogb.md b/docs/content/showcase/gogb.md deleted file mode 100644 index d104741ba..000000000 --- a/docs/content/showcase/gogb.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -lastmod: 2015-05-25 -date: 2013-11-01T07:32:00Z -description: "" -license: MIT -licenseLink: "" -sitelink: http://getgb.io -tags: -- project -thumbnail: /img/gogb-tn.jpg -title: GoGB ---- - diff --git a/docs/content/showcase/goin5minutes.md b/docs/content/showcase/goin5minutes.md deleted file mode 100644 index ae0c61da3..000000000 --- a/docs/content/showcase/goin5minutes.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -lastmod: 2015-11-20 -date: 2015-11-20T20:46:00Z -description: "Code for Go in 5 Minutes Screencasts" -license: "Apache License 2.0" -licenseLink: "https://github.com/arschles/go-in-5-minutes/blob/master/LICENSE" -sitelink: http://www.goin5minutes.com/ -sourceLink: https://github.com/arschles/go-in-5-minutes/tree/master/www -tags: -- screencasts -thumbnail: /img/goin5minutes-tn.png -title: Go in 5 minutes ----
\ No newline at end of file diff --git a/docs/content/showcase/h10n.me.md b/docs/content/showcase/h10n.me.md deleted file mode 100644 index 0576edb1f..000000000 --- a/docs/content/showcase/h10n.me.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -date: 2016-03-05T14:30:21+01:00 -description: "Personal profile page of Horst Gutmann" -sitelink: http://h10n.me/ -sourceLink: https://github.com/zerok/h10n.me -tags: -- personal -- profile -thumbnail: /img/h10n.me-tn.png -title: h10n.me ---- diff --git a/docs/content/showcase/heimatverein-niederjosbach.md b/docs/content/showcase/heimatverein-niederjosbach.md deleted file mode 100644 index d063e9c50..000000000 --- a/docs/content/showcase/heimatverein-niederjosbach.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -date: 2017-01-02T07:32:00Z -description: "" -license: "" -licenseLink: "" -sitelink: http://heimatverein-niederjosbach.de/ -sourceLink: https://github.com/Dbzman/heimatverein-niederjosbach.de -tags: -- association -- gallery -thumbnail: /img/heimatverein-niederjosbach-tn.png -title: Niederjosbacher Heimat- und Geschichtsverein 2007 e.V. ---- - diff --git a/docs/content/showcase/hugo.md b/docs/content/showcase/hugo.md deleted file mode 100644 index 54c9ce09a..000000000 --- a/docs/content/showcase/hugo.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2015-01-27 -date: 2013-07-01T07:32:00Z -description: This site -license: Simpl -licenseLink: "" -sitelink: http://gohugo.io/ -sourceLink: https://github.com/gohugoio/hugo/tree/master/docs -tags: -- documentation -- bootstrap -thumbnail: /img/hugo-tn.jpg -title: Hugo ---- - diff --git a/docs/content/showcase/invision.md b/docs/content/showcase/invision.md deleted file mode 100644 index baf1fc463..000000000 --- a/docs/content/showcase/invision.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: 2017-01-28T12:04:00Z -description: InVision Engineering Blog -license: "" -licenseLink: "" -sitelink: http://engineering.invisionapp.com -tags: -- company -- blog -- engineering -thumbnail: /img/invision-tn.png -title: InVision Engineering Blog ---- diff --git a/docs/content/showcase/jamescampbell.md b/docs/content/showcase/jamescampbell.md deleted file mode 100644 index de7fa62a2..000000000 --- a/docs/content/showcase/jamescampbell.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -date: 2016-06-06T14:42:59-04:00 -description: "" -license: "" -licenseLink: "" -sitelink: https://jamescampbell.us/ -sourceLink: https://github.com/jamesacampbell/causes-and-effects-hugo -tags: -- personal -- blog -thumbnail: /img/jamescampbell-tn.png -title: jamescampbell.us ---- - - diff --git a/docs/content/showcase/jorgennilsson.md b/docs/content/showcase/jorgennilsson.md deleted file mode 100644 index 7821eea7d..000000000 --- a/docs/content/showcase/jorgennilsson.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -date: 2016-02-11T23:41:27+01:00 -description: "Personal web site and blog of digital director Jorgen Nilsson" -license: "" -licenseLink: "" -sitelink: http://jorgennilsson.com/ -tags: -- personal -- blog -thumbnail: /img/jorgennilsson-tn.png -title: jorgennilsson.com ---- diff --git a/docs/content/showcase/kieranhealy.md b/docs/content/showcase/kieranhealy.md deleted file mode 100644 index f4f32989c..000000000 --- a/docs/content/showcase/kieranhealy.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -lastmod: 2015-01-27 -date: 2014-02-27T20:35:00Z -description: Kieran Healy's Website -license: "" -licenseLink: "" -sitelink: http://kieranhealy.org/ -sourceLink: https://github.com/kjhealy/kieranhealy.hugo -tags: -- personal -- blog -- academic -thumbnail: /img/kjhealy-tn.jpg -title: Kieran Healy ---- - diff --git a/docs/content/showcase/klingt-net.md b/docs/content/showcase/klingt-net.md deleted file mode 100644 index 369e44cdb..000000000 --- a/docs/content/showcase/klingt-net.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -date: 2016-05-15T23:18:16+02:00 -description: "klingt.net is the personal homepage of Andreas Linz." -license: "" -licenseLink: "" -sitelink: https://klingt.net/ -sourceLink: https://github.com/klingtnet/klingt.net -tags: -- personal -- blog -- programming -thumbnail: /img/klingt-net-tn.png -title: klingt net ---- - diff --git a/docs/content/showcase/launchcode5.md b/docs/content/showcase/launchcode5.md deleted file mode 100644 index 99bea2cfb..000000000 --- a/docs/content/showcase/launchcode5.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -lastmod: 2015-01-27 -date: 2014-11-01T07:32:00Z -description: Corporate Site for Launchcode Software Studios -license: Copyright Launchcode Software Studios -licenseLink: "" -sitelink: http://www.launchcode5.com/ -sourceLink: https://github.com/Launchcode5/launchcode5.com -tags: -- bootstrap -thumbnail: /img/launchcode-tn.jpg -title: Launchcode Software Studios ---- - diff --git a/docs/content/showcase/leepenney.md b/docs/content/showcase/leepenney.md deleted file mode 100644 index db8bfb45b..000000000 --- a/docs/content/showcase/leepenney.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -lastmod: 2016-01-24 -date: 2016-01-24T16:10:00Z -description: Site of author Lee Penney -license: MIT -licenseLink: "" -sitelink: http://leepenney.com/ -tags: -- personal -- website -thumbnail: /img/leepenney-tn.jpg -title: Lee Penney ---- - diff --git a/docs/content/showcase/leowkahman.md b/docs/content/showcase/leowkahman.md deleted file mode 100644 index a7ce50418..000000000 --- a/docs/content/showcase/leowkahman.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -date: 2016-07-24T00:00:00+08:00 -description: "Leow Kah Man - Tech Blog" -license: "" -licenseLink: "" -sitelink: https://www.leowkahman.com/ -tags: -- personal -- blog -thumbnail: /img/leowkahman-tn.png -title: Leow Kah Man - Tech Blog ----
\ No newline at end of file diff --git a/docs/content/showcase/lk4d4.darth.io.md b/docs/content/showcase/lk4d4.darth.io.md deleted file mode 100644 index a35773380..000000000 --- a/docs/content/showcase/lk4d4.darth.io.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2014-08-26 -date: 2014-08-25T18:59:30-04:00 -description: Alexandr Morozov -license: "" -licenseLink: "" -sitelink: http://lk4d4.darth.io/ -sourceLink: https://github.com/LK4D4/lk4d4.darth.io -tags: -- personal -- blog -thumbnail: /img/lk4d4-tn.jpg -title: lk4d4.darth.io ---- - diff --git a/docs/content/showcase/losslesslife.md b/docs/content/showcase/losslesslife.md deleted file mode 100644 index 5e7158daa..000000000 --- a/docs/content/showcase/losslesslife.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2015-11-15 -date: 2015-11-15T11:20:00-08:00 -description: "Losslesslife covers everything high-end and audiophile headphones. Headphones and headphone amplifiers, accessories, how-to guides, and reviews." -sitelink: http://pages.losslesslife.com/ -tags: -- headphones -- electronics -- technical -- reviews -- education -- audiophile -thumbnail: /img/losslesslife-tn.png -title: LosslessLife ---- diff --git a/docs/content/showcase/lucumt.info.md b/docs/content/showcase/lucumt.info.md deleted file mode 100644 index 0f66b294f..000000000 --- a/docs/content/showcase/lucumt.info.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -date: 2017-03-12T13:14:14+08:00 -description: "Personal blog of Rosen Lu" -license: "" -licenseLink: "" -sitelink: http://lucumt.info/posts -sourceLink: https://github.com/lucumt/ghblog -tags: -- personal -- blog -thumbnail: /img/lucumt.info.png -title: 飞狐的部落格 ---- - diff --git a/docs/content/showcase/mariosanchez.md b/docs/content/showcase/mariosanchez.md deleted file mode 100644 index 99285f871..000000000 --- a/docs/content/showcase/mariosanchez.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -lastmod: 2015-06-20 -date: 2015-06-20 -description: "" -license: "" -licenseLink: "" -sitelink: http://mariosanchez.org/ -sourceLink: https://github.com/mariobox/Hugo-Source -tags: -- personal -- blog -thumbnail: /img/mariosanchez-tn.jpg -title: mariosanchez.org ---- diff --git a/docs/content/showcase/mayan-edms.md b/docs/content/showcase/mayan-edms.md deleted file mode 100644 index 656a6790c..000000000 --- a/docs/content/showcase/mayan-edms.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -date: 2016-06-13T19:38:56-04:00 -description: "Free Open Source Document Management System" -license: "Apache 2.0" -licenseLink: "" -sitelink: http://www.mayan-edms.com/ -sourceLink: https://gitlab.com/mayan-edms/website -tags: -- paperless -- floss -thumbnail: /img/mayan-edms-tn.png -title: Mayan EDMS ---- - diff --git a/docs/content/showcase/michaelwhatcott.md b/docs/content/showcase/michaelwhatcott.md deleted file mode 100644 index 9c5bcd07f..000000000 --- a/docs/content/showcase/michaelwhatcott.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2014-08-26 -date: 2014-08-26T11:47:11-04:00 -description: "" -license: Simpl-2.0 -licenseLink: "" -sitelink: http://michaelwhatcott.com/ -sourceLink: https://bitbucket.org/mdwhatcott/michaelwhatcott.com-boilerplate/src -tags: -- personal -- blog -thumbnail: /img/michaelwhatcott-tn.jpg -title: michaelwhatcott ---- - diff --git a/docs/content/showcase/mongodb-eng-journal.md b/docs/content/showcase/mongodb-eng-journal.md deleted file mode 100644 index 9dc5ea0ad..000000000 --- a/docs/content/showcase/mongodb-eng-journal.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: 2016-03-09T14:14:16-05:00 -description: "The MongoDB Engineering Journal -- for builders, by builders." -license: "" -licenseLink: "" -sitelink: http://engineering.mongodb.com/ -tags: -- engineering -- blog -thumbnail: /img/mongodb-eng-tn.png -title: The Mongodb Engineering Journal ---- - diff --git a/docs/content/showcase/mtbhomer.md b/docs/content/showcase/mtbhomer.md deleted file mode 100644 index a98c59621..000000000 --- a/docs/content/showcase/mtbhomer.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -date: 2016-06-19T11:38:39+02:00 -description: "Personal website Martijn ten Bhömer" -license: "" -licenseLink: "" -sitelink: https://www.mtbhomer.com/ -sourceLink: https://github.com/mtbhomer/web-portfolio -tags: -- personal -- portfolio -- design -thumbnail: /img/mtbhomer-tn.png -title: mtbhomer.com ---- diff --git a/docs/content/showcase/myearworms.md b/docs/content/showcase/myearworms.md deleted file mode 100644 index 17d0549f3..000000000 --- a/docs/content/showcase/myearworms.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -date: 2017-03-08T07:32:00Z -description: "All the songs that get stuck in my head" -license: "" -licenseLink: "" -sitelink: https://myearworms.com/ -sourceLink: https://github.com/jaydreyer/myearworms -tags: -- personal -- blog -- music -thumbnail: /img/myearworms-tn.jpg -title: My Earworms ---- diff --git a/docs/content/showcase/neavey.net.md b/docs/content/showcase/neavey.net.md deleted file mode 100644 index 443d2b670..000000000 --- a/docs/content/showcase/neavey.net.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -date: 2016-12-21T21:19:46Z -description: "Adventure Miles - A personal travel blog." -license: "MIT" -licenseLink: "https://raw.githubusercontent.com/patrickn/neaveynet-hugo/master/LICENSE.md" -sitelink: http://neavey.net/ -sourceLink: https://github.com/patrickn/neaveynet-hugo -tags: -- personal -- travel -- blog -thumbnail: /img/neavey-tn.jpg -title: neavey.net ---- diff --git a/docs/content/showcase/nickoneill.md b/docs/content/showcase/nickoneill.md deleted file mode 100644 index 405a9f945..000000000 --- a/docs/content/showcase/nickoneill.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2014-08-26 -date: 2014-08-26T12:15:48-04:00 -description: "" -license: "" -licenseLink: "" -sitelink: http://blog.nickoneill.name/ -sourceLink: https://github.com/nickoneill/blog.nickoneill.name -tags: -- personal -- blog -thumbnail: /img/nickoneill-tn.jpg -title: authenticgeek ---- - diff --git a/docs/content/showcase/ninjaducks.in.md b/docs/content/showcase/ninjaducks.in.md deleted file mode 100644 index 46be436fc..000000000 --- a/docs/content/showcase/ninjaducks.in.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -lastmod: 2015-10-24 -date: 2015-10-24T14:06:00+05:30 -description: Personal blog -license: "" -licenseLink: "" -sitelink: http://ninjaducks.in -sourceLink: https://github.com/shivanshuag/shivanshuag.github.io/tree/new -tags: -- personal -- blog -thumbnail: /img/ninjaducks-tn.png -title: ninjaducks.in ---- diff --git a/docs/content/showcase/ninya.io.md b/docs/content/showcase/ninya.io.md deleted file mode 100644 index a7ac4fe99..000000000 --- a/docs/content/showcase/ninya.io.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2014-08-26 -date: 2014-08-26T09:47:00-04:00 -description: "" -license: "" -licenseLink: "" -sitelink: http://blog.ninya.io/ -sourceLink: https://github.com/ninya-io/ninya-io.github.io/tree/dev -tags: -- project -- blog -thumbnail: /img/ninya-tn.jpg -title: ninya.io ---- - diff --git a/docs/content/showcase/nodesk.md b/docs/content/showcase/nodesk.md deleted file mode 100644 index 8656c7ec0..000000000 --- a/docs/content/showcase/nodesk.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -lastmod: 2015-08-26 -date: 2015-08-26T22:33:00Z -description: "NoDesk | All Things Digital Nomad" -sitelink: http://nodesk.co/ -tags: -- digital nomad -- web -thumbnail: /img/nodesk-tn.png -title: nodesk.co ---- diff --git a/docs/content/showcase/novelist-xyz.md b/docs/content/showcase/novelist-xyz.md deleted file mode 100644 index e0b59fb41..000000000 --- a/docs/content/showcase/novelist-xyz.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: 2016-05-22T17:54:51+08:00 -description: "Peter Y. Chuang - Novelist, Short Story Writer" -license: "" -licenseLink: "" -sitelink: https://novelist.xyz -sourceLink: https://github.com/peterychuang/peterychuang.github.io/tree/source -tags: -- personal -- blog -thumbnail: /img/novelist-xyz.png -title: Peter Y. Chuang ---- diff --git a/docs/content/showcase/npf.md b/docs/content/showcase/npf.md deleted file mode 100644 index b11f6cbc4..000000000 --- a/docs/content/showcase/npf.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2015-01-27 -date: 2014-08-21T12:21:18-04:00 -description: "" -license: "" -licenseLink: "" -sitelink: http://npf.io/ -sourceLink: https://github.com/natefinch/npf -tags: -- personal -- blog -thumbnail: /img/npf-tn.jpg -title: npf.io ---- - diff --git a/docs/content/showcase/nutspubcrawl.md b/docs/content/showcase/nutspubcrawl.md deleted file mode 100644 index bb5ddf6d8..000000000 --- a/docs/content/showcase/nutspubcrawl.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -date: 2017-06-03T07:32:00Z -description: "" -license: "" -licenseLink: "" -sitelink: https://nutspubcrawl.com/ -sourceLink: https://github.com/jeremielondon/nuts-hugo -tags: -- company -- multilingual -- London -thumbnail: /img/nutspubcrawl.jpg -title: Nutspubcrawl.com ---- - diff --git a/docs/content/showcase/ocul-maps.md b/docs/content/showcase/ocul-maps.md deleted file mode 100644 index 516bda399..000000000 --- a/docs/content/showcase/ocul-maps.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -date: 2017-05-09T11:04:33-04:00 -description: "The Ontario Council of University Libraries Historical Topographic Maps Digitization Project" -license: "" -licenseLink: "" -sitelink: http://ocul.on.ca/topomaps -sourcelink: https://github.com/scholarsportal/historical-topos -tags: -- education -- project -- multilingual -thumbnail: /img/ocul-maps.png -title: OCUL topographic maps ---- diff --git a/docs/content/showcase/petanikode.md b/docs/content/showcase/petanikode.md deleted file mode 100644 index 7ebd51b9f..000000000 --- a/docs/content/showcase/petanikode.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -date: 2017-01-10T07:32:00Z -description: "Programmer Pengguna Linux" -license: "" -licenseLink: "" -sitelink: http://petanikode.com/ -tags: -- programming -- blog -thumbnail: /img/petanikode.png -title: Petani Kode ---- diff --git a/docs/content/showcase/peteraba.md b/docs/content/showcase/peteraba.md deleted file mode 100644 index c00373e54..000000000 --- a/docs/content/showcase/peteraba.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2014-08-26 -date: 2014-08-26T11:30:57-04:00 -description: "" -license: "" -licenseLink: "" -sitelink: https://peteraba.com/ -sourceLink: https://github.com/peteraba/peteraba.com -tags: -- personal -- blog -thumbnail: /img/peteraba-tn.jpg -title: peteraba ---- - diff --git a/docs/content/showcase/picturingjordan.md b/docs/content/showcase/picturingjordan.md deleted file mode 100644 index c0005312a..000000000 --- a/docs/content/showcase/picturingjordan.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -date: 2017-01-22T17:32:00Z -description: "Sharing Jordan with the world — one picture at a time." -license: "Creative Commons Attribution 4.0 International" -licenseLink: https://creativecommons.org/licenses/by-sa/4.0/ -sitelink: https://picturingjordan.com/ -sourceLink: https://github.com/alanorth/picturingjordan.com -tags: -- personal -- blog -thumbnail: /img/picturingjordan-tn.png -title: picturingjordan.com ---- - diff --git a/docs/content/showcase/promotive.md b/docs/content/showcase/promotive.md deleted file mode 100644 index 45e99d1a1..000000000 --- a/docs/content/showcase/promotive.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -date: 2017-02-21T12:26:26+01:00 -description: "Corporate website a event management agency" -license: "" -licenseLink: "" -sitelink: https://promotive.es -tags: -- company -- corporate -- spanish -- event management -- bootstrap -thumbnail: /img/promotive.png -title: Promotive ---- diff --git a/docs/content/showcase/rahulrai.md b/docs/content/showcase/rahulrai.md deleted file mode 100644 index 1970ad683..000000000 --- a/docs/content/showcase/rahulrai.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: 2016-10-04T21:01:18+01:00 -description: "My Take on Cloud" -license: "" -licenseLink: "" -sitelink: https://rahulrai.in -sourceLink: https://github.com/moonytheloony/Blog-Web -tags: -- personal -- blog -thumbnail: /img/rahulrai_in-tn.png -title: My Take on Cloud ---- diff --git a/docs/content/showcase/rakutentech.md b/docs/content/showcase/rakutentech.md deleted file mode 100644 index b78b3e8b1..000000000 --- a/docs/content/showcase/rakutentech.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -lastmod: 2016-01-20 -date: 2016-01-20T07:32:00Z -description: "" -license: MIT -licenseLink: "" -sitelink: http://techblog.rakuten.co.jp/ -tags: -- company -- blog -thumbnail: /img/rakutentech-tn.png -title: Rakuten Tech Blog ---- - diff --git a/docs/content/showcase/rdegges.md b/docs/content/showcase/rdegges.md deleted file mode 100644 index 2d7589b60..000000000 --- a/docs/content/showcase/rdegges.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -date: 2016-08-05T15:33:56-07:00 -description: "The personal website of Randall Degges." -license: "Unlicense" -licenseLink: "http://unlicense.org/" -sitelink: https://www.rdegges.com/ -sourceLink: https://github.com/rdegges/rdegges-www -tags: -- personal -- blog -thumbnail: /img/rdegges-tn.png -title: Randall Degges ---- - diff --git a/docs/content/showcase/readtext.md b/docs/content/showcase/readtext.md deleted file mode 100644 index 330d89ca2..000000000 --- a/docs/content/showcase/readtext.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -lastmod: 2015-11-16 -date: 2015-11-16T08:36:00Z -description: Restored text files -sitelink: http://readtext.org/ -tags: -- textfiles -- reading -thumbnail: /img/readtext-tn.png -title: ReadText ---- - diff --git a/docs/content/showcase/richardsumilang.md b/docs/content/showcase/richardsumilang.md deleted file mode 100644 index 8d4e97d09..000000000 --- a/docs/content/showcase/richardsumilang.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -lastmod: 2015-09-08 -date: 2015-09-07T00:12:00-07:00 -description: "Personal website dedicated to electronics, programming, and reviews." -license: "MIT" -licenseLink: "https://opensource.org/licenses/MIT" -sitelink: http://richardsumilang.com/ -sourceLink: https://github.com/richardsumilang-blog -tags: -- personal -- blog -- technical -- electronics -- reviews -thumbnail: /img/richardsumilang-tn.png -title: Richard Sumilang - Top Secret Labs ---- diff --git a/docs/content/showcase/rick-cogley-info.md b/docs/content/showcase/rick-cogley-info.md deleted file mode 100644 index 997a45757..000000000 --- a/docs/content/showcase/rick-cogley-info.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -lastmod: 2016-02-01 -date: 2015-05-20T04:32:00Z -description: Rick Cogley's personal site, powered by Hugo. -license: MIT -licenseLink: "" -sitelink: http://rick.cogley.info/ -sourceLink: https://github.com/RickCogley/RCC-Hugo2015 -tags: -- personal -- blog -- rickcogley -- japan -thumbnail: /img/rick_cogley_info-tn.jpg -title: rick.cogley.info ---- diff --git a/docs/content/showcase/ridingbytes.md b/docs/content/showcase/ridingbytes.md deleted file mode 100644 index 29fbb2ecf..000000000 --- a/docs/content/showcase/ridingbytes.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -lastmod: 2015-10-01 -date: 2015-09-27T00:00:00Z -description: Official Company Website -license: "" -licenseLink: "" -sitelink: http://ridingbytes.com/ -tags: -- company -- website -- blog -- tech -thumbnail: /img/ridingbytes-tn.png -title: RIDING BYTES ---- - diff --git a/docs/content/showcase/robertbasic.md b/docs/content/showcase/robertbasic.md deleted file mode 100644 index 237fce837..000000000 --- a/docs/content/showcase/robertbasic.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2016-03-26 -date: 2016-03-26T17:47:40+01:00 -description: "Robert Basic is a web developer from Serbia." -license: "" -licenseLink: "" -sitelink: http://robertbasic.com/ -sourceLink: https://github.com/robertbasic/robertbasic.com-hugo -tags: -- personal -- blog -thumbnail: /img/robertbasic-tn.png -title: Robert Basic's blog ---- - diff --git a/docs/content/showcase/sanjay-saxena.md b/docs/content/showcase/sanjay-saxena.md deleted file mode 100644 index df869414d..000000000 --- a/docs/content/showcase/sanjay-saxena.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -date: 2017-04-13T07:32:00Z -description: "" -license: "" -licenseLink: "" -sitelink: https://sanjay-saxena.github.io -sourceLink: https://github.com/sanjay-saxena/sanjay-saxena-hugo -tags: -- personal -- blog -thumbnail: /img/sanjay-saxena-tn.png -title: sanjay-saxena.github.io ---- - diff --git a/docs/content/showcase/scottcwilson.md b/docs/content/showcase/scottcwilson.md deleted file mode 100644 index 9d07cf123..000000000 --- a/docs/content/showcase/scottcwilson.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2015-08-08 -date: 2015-07-21T10:00:00Z -description: Personal portfolio, created with Hugo -license: MIT -licenseLink: "" -sitelink: http://scottcwilson.github.io/ -sourceLink: https://github.com/scottcwilson/hugosite -tags: -- personal -- blog -thumbnail: /img/scottcwilson-tn.png -title: scottcwilson.com ---- - diff --git a/docs/content/showcase/shapeshed.md b/docs/content/showcase/shapeshed.md deleted file mode 100644 index 8e8908d00..000000000 --- a/docs/content/showcase/shapeshed.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -date: 2016-10-10T07:32:00Z -description: Personal blog. -license: "" -licenseLink: "" -sitelink: http://shapeshed.com/ -sourceLink: https://github.com/shapeshed/shapeshed.com -tags: -- personal -- blog -thumbnail: /img/shapeshed-tn.png -title: shapeshed.com ---- - diff --git a/docs/content/showcase/shelan.md b/docs/content/showcase/shelan.md deleted file mode 100644 index 230b7b04f..000000000 --- a/docs/content/showcase/shelan.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -lastmod: 2016-02-07 -date: 2016-02-07T10:30:00Z -description: Shelan's Blog -license: MIT -licenseLink: "" -sitelink: http://shelan.org/ -sourceLink: https://github.com/shelan/my-hugo-site -tags: -- personal -- blog -thumbnail: /img/shelan-tn.png -title: shelan.org ----
\ No newline at end of file diff --git a/docs/content/showcase/siba.md b/docs/content/showcase/siba.md deleted file mode 100644 index 21f6f2a5f..000000000 --- a/docs/content/showcase/siba.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -date: 2017-08-01T08:12:00Z -description: "All-in-One Intelligent Bot for Business" -license: "" -licenseLink: "" -sitelink: http://siba.ai/ -tags: -- corporate -- saas -- software -- chatbot -- blog -thumbnail: /img/siba-tn.png -title: Siba Chatbot ---- - diff --git a/docs/content/showcase/silvergeko.md b/docs/content/showcase/silvergeko.md deleted file mode 100644 index 3e0105f30..000000000 --- a/docs/content/showcase/silvergeko.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -date: 2016-03-28T14:16:59+02:00 -description: "Custom theme of small italian software house" -license: "" -licenseLink: "" -sitelink: http://silvergeko.it/ -tags: -- profesional -thumbnail: /img/silvergeko.jpg -title: Silvergeko ---- - diff --git a/docs/content/showcase/softinio.md b/docs/content/showcase/softinio.md deleted file mode 100644 index fdbd5f364..000000000 --- a/docs/content/showcase/softinio.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2016-03-11 -date: 2015-11-29T07:16:53-05:00 -description: Salar Rahmanian Blog -license: MIT -licenseLink: https://raw.githubusercontent.com/softinio/softinio.com/master/LICENSE -sitelink: http://www.softinio.com/ -sourceLink: https://github.com/softinio/softinio.com -tags: -- personal -- technical -- blog -thumbnail: /img/softinio-tn.png -title: Salar Rahmanian ---- diff --git a/docs/content/showcase/spf13.md b/docs/content/showcase/spf13.md deleted file mode 100644 index e0b524255..000000000 --- a/docs/content/showcase/spf13.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2015-01-27 -date: 2013-07-01T07:32:00Z -description: The first Hugo powered website. -license: MIT -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/docs/content/showcase/steambap.md b/docs/content/showcase/steambap.md deleted file mode 100644 index 439c12e8b..000000000 --- a/docs/content/showcase/steambap.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: 2016-07-28T07:32:00Z -description: Weilin's blog -license: MIT -licenseLink: "" -sitelink: http://weilinshi.org/ -sourceLink: https://github.com/steambap/weilinshi.org -tags: -- personal -- blog -thumbnail: /img/steambap.png -title: weilinshi ---- diff --git a/docs/content/showcase/stefano.chiodino.md b/docs/content/showcase/stefano.chiodino.md deleted file mode 100644 index 5880eb9ed..000000000 --- a/docs/content/showcase/stefano.chiodino.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -date: 2016-05-21T21:25:25+01:00 -description: "Personal site + blog" -license: "" -licenseLink: "" -sitelink: https://stefano.chiodino.uk/ -sourceLink: https://github.com/Draga/go-web -tags: -- personal -- blog -thumbnail: /img/stefano.chiodino-tn.jpg -title: stefano.chiodino.uk ---- - diff --git a/docs/content/showcase/stou.md b/docs/content/showcase/stou.md deleted file mode 100644 index ddd4b313b..000000000 --- a/docs/content/showcase/stou.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2015-01-27 -date: 2014-11-23T01:28:16+07:00 -description: "Rasmus Stougaard" -license: "" -licenseLink: "" -sitelink: http://stou.dk/ -sourceLink: "https://github.com/stou/stou.github.io" -tags: -- personal -- blog -thumbnail: /img/stou-tn.png -title: stou.dk ---- - diff --git a/docs/content/showcase/szymonkatra.md b/docs/content/showcase/szymonkatra.md deleted file mode 100644 index 1be52b94c..000000000 --- a/docs/content/showcase/szymonkatra.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2015-07-10 -date: 2015-07-10T16:15:00+01:00 -description: Szymon Katra -license: "" -licenseLink: "" -sitelink: http://szymonkatra.github.io/ -sourceLink: https://github.com/SzymonKatra/SzymonKatra.github.io/tree/master/hugo_project -tags: -- personal -- blog -thumbnail: /img/szymonkatra-tn.png -title: szymonkatra.github.io ---- - diff --git a/docs/content/showcase/techmadeplain.md b/docs/content/showcase/techmadeplain.md deleted file mode 100644 index 25712751d..000000000 --- a/docs/content/showcase/techmadeplain.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -lastmod: 2015-01-27 -date: 2014-05-22T19:54:00Z -description: Tech Coaching site -license: "" -licenseLink: "" -sitelink: http://techmadeplain.com/ -tags: -- personal -- blog -thumbnail: /img/techmadeplain-tn.jpg -title: Tech Made Plain ---- - diff --git a/docs/content/showcase/tendermint.md b/docs/content/showcase/tendermint.md deleted file mode 100644 index d95e3c090..000000000 --- a/docs/content/showcase/tendermint.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -lastmod: 2014-08-26 -date: 2014-08-26T09:34:42-04:00 -description: "" -license: "" -licenseLink: "" -sitelink: http://tendermint.com/ -sourceLink: https://github.com/tendermint/tendermint.github.io -tags: -- project -thumbnail: /img/tendermint-tn.jpg -title: tendermint ---- - diff --git a/docs/content/showcase/thecodeking.md b/docs/content/showcase/thecodeking.md deleted file mode 100644 index 86786d736..000000000 --- a/docs/content/showcase/thecodeking.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: 2016-10-09T23:06:16+01:00 -description: "Personal site for articles and projects." -license: "" -licenseLink: "" -sitelink: http://thecodeking.co.uk -tags: -- personal -- blog -thumbnail: /img/thecodeking-tn.jpg -title: thecodeking ---- - diff --git a/docs/content/showcase/thehome.md b/docs/content/showcase/thehome.md deleted file mode 100644 index 1db5706f3..000000000 --- a/docs/content/showcase/thehome.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2015-08-08 -date: 2014-12-27T20:00:00+07:00 -description: "Tom Helmer Hansen" -license: "" -licenseLink: "" -sitelink: http://www.thehome.dk/ -sourceLink: "https://github.com/tomhelmer/website-source" -tags: -- personal -- blog -thumbnail: /img/thehome-tn.png -title: thehome.dk ---- - diff --git a/docs/content/showcase/thislittleduck.md b/docs/content/showcase/thislittleduck.md deleted file mode 100644 index 295b9cd32..000000000 --- a/docs/content/showcase/thislittleduck.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -date: 2017-06-04T21:30:00+10:00 -description: "Software company website" -sitelink: https://thislittleduck.com -tags: -- business -- portfolio -thumbnail: /img/thislittleduck-tn.png -title: This Little Duck ---- - diff --git a/docs/content/showcase/tibobeijen.nl.md b/docs/content/showcase/tibobeijen.nl.md deleted file mode 100644 index 37db6491b..000000000 --- a/docs/content/showcase/tibobeijen.nl.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -date: 2017-03-18T11:30:00Z -description: "Blog of programmer Tibo Beijen" -license: "" -licenseLink: "" -sitelink: https://www.tibobeijen.nl/ -sourceLink: https://github.com/TBeijen/tbnl-hugo -tags: -- personal -- programming -- blog -thumbnail: /img/tibobeijen-nl-tn.png -title: tibobeijen.nl ---- - diff --git a/docs/content/showcase/ttsreader.md b/docs/content/showcase/ttsreader.md deleted file mode 100644 index 90f02763b..000000000 --- a/docs/content/showcase/ttsreader.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -date: 2017-05-19T07:32:00Z -description: "Online Text to Speech App and Content" -license: "" -licenseLink: "" -sitelink: http://ttsreader.com/ -tags: -- text to speech -- app -- blog -- showcase -- company -thumbnail: /img/ttsreader-tn.png -title: TTSReader ---- diff --git a/docs/content/showcase/tutorialonfly.md b/docs/content/showcase/tutorialonfly.md deleted file mode 100644 index 7c975aaa9..000000000 --- a/docs/content/showcase/tutorialonfly.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2016-04-15 -date: 2016-04-15T01:28:16+08:00 -description: "Tutorialonfly.com provide free tutorials in gitbook version online and pdf,epub,mobi etc for offline read, it's a great website built on hugo, thanks spf13 who created hugo" -license: "" -licenseLink: "" -sitelink: https://tutorialonfly.com/ -tags: -- tutorials -- free -- ebook download -- fast -thumbnail: /img/tutorialonfly-tn.jpg -title: Tutorialonfly ----
\ No newline at end of file diff --git a/docs/content/showcase/tutswiki.md b/docs/content/showcase/tutswiki.md deleted file mode 100644 index 72bd65844..000000000 --- a/docs/content/showcase/tutswiki.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -lastmod: 2017-05-23 -date: 2017-05-23T07:33:00Z -description: "Collaborative tutorials for the internet" -license: "" -licenseLink: "" -sitelink: https://tutswiki.com/ -sourceLink: https://github.com/TutsWiki/source -tags: -- tutorial -- wiki -- computer science -- programming -- documentation -- books -thumbnail: /img/tutswiki-tn.jpg -title: TutsWiki.com ---- - diff --git a/docs/content/showcase/ucsb.md b/docs/content/showcase/ucsb.md deleted file mode 100644 index 9f9ff77e7..000000000 --- a/docs/content/showcase/ucsb.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -lastmod: 2014-11-25 -date: 2014-08-26T14:12:55-04:00 -description: "" -license: "" -licenseLink: "" -sitelink: http://philosophy.ucsb.edu/ -sourceLink: https://github.com/ucsbphil/philweb -tags: -- education -thumbnail: /img/ucsb-tn.jpg -title: ucsb ---- - diff --git a/docs/content/showcase/upbeat.md b/docs/content/showcase/upbeat.md deleted file mode 100644 index 7c5b0fe57..000000000 --- a/docs/content/showcase/upbeat.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: 2016-06-12T11:57:53+02:00 -description: "Blog by Rocchi Cesare" -license: "" -licenseLink: "" -sitelink: http://upbeat.it/ -sourceLink: -tags: -- personal -- blog -thumbnail: /img/upbeat.png -title: upbeat ---- diff --git a/docs/content/showcase/vamp.md b/docs/content/showcase/vamp.md deleted file mode 100644 index a2591dbb8..000000000 --- a/docs/content/showcase/vamp.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -lastmod: 2015-08-08 -date: 2014-06-26T15:45:00Z -description: Vamp.io microservices platform homepage and documentation -license: "Apache 2" -licenseLink: "" -sitelink: http://vamp.io/ -tags: -- tech -- documentation -- company -- api -thumbnail: /img/vamp_landingpage-tn.png -title: Vamp.io ---- - diff --git a/docs/content/showcase/viglug.org.md b/docs/content/showcase/viglug.org.md deleted file mode 100644 index a9e78290a..000000000 --- a/docs/content/showcase/viglug.org.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2016-03-01 -date: 2016-03-01T11:20:00Z -description: ViGLug.org is the website of the Linux User Group of Milan Est (Italy) -license: "AGPLv3" -licenseLink: "" -sitelink: http://viglug.org/ -tags: -- tech -- linux -- user group -thumbnail: /img/viglug-tn.png -title: Viglug.org ---- - diff --git a/docs/content/showcase/vurt.co.md b/docs/content/showcase/vurt.co.md deleted file mode 100644 index 6da6aa09d..000000000 --- a/docs/content/showcase/vurt.co.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -lastmod: 2014-08-26 -date: 2014-08-26T12:09:39-04:00 -description: "" -license: "" -licenseLink: "" -sitelink: http://vurt.co.uk/ -sourceLink: https://github.com/gilesp/vurtcouk -tags: -- personal -- blog -thumbnail: /img/vurt.co-tn.jpg -title: vurt.co.uk ---- - diff --git a/docs/content/showcase/worldtowriters.md b/docs/content/showcase/worldtowriters.md deleted file mode 100644 index d28fc3e43..000000000 --- a/docs/content/showcase/worldtowriters.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -lastmod: 2017-05-12 -date: 2017-05-12T22:00:00Z -description: "A translation service agency site" -license: MIT -licenseLink: "" -sitelink: https://worldtowriters.com -tags: -- company -- translation -thumbnail: /img/worldtowriters-com.jpg -title: World to Writers translation site ---- - diff --git a/docs/content/showcase/yslow-rules.md b/docs/content/showcase/yslow-rules.md deleted file mode 100644 index ccc84bfbb..000000000 --- a/docs/content/showcase/yslow-rules.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -lastmod: 2015-08-08 -date: 2014-04-07T10:45:00Z -description: Community project of YSlow rules translations -license: MIT License -licenseLink: https://raw.github.com/checkmyws/yslow-rules/master/LICENSE -sitelink: http://checkmyws.github.io/yslow-rules/ -sourceLink: https://github.com/checkmyws/yslow-rules -tags: -- community -- documentation -- translation -thumbnail: /img/yslow-rules-tn.png -title: YSlow Rules ---- - diff --git a/docs/content/showcase/ysqi.md b/docs/content/showcase/ysqi.md deleted file mode 100644 index 56bf06bd1..000000000 --- a/docs/content/showcase/ysqi.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -date: 2016-03-25T09:05:49+08:00 -description: "虞双齐个人博客" -license: "MIT" -licenseLink: "https://opensource.org/licenses/MIT" -sitelink: https://www.yushuangqi.com/ -sourceLink: https://github.com/ysqi/yushuangqi.com/ -tags: -- personal -- blog -thumbnail: /img/ysqi-blog.png -title: yushuangqi-blog ---- diff --git a/docs/content/showcase/yulinling.net.md b/docs/content/showcase/yulinling.net.md deleted file mode 100644 index b5a6559f1..000000000 --- a/docs/content/showcase/yulinling.net.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -lastmod: 2015-12-19 -date: 2015-09-09T21:42:00-04:00 -description: Multilingual, blog -license: "" -licenseLink: "" -sitelink: https://yulinling.net/ -sourceLink: https://bitbucket.org/lynxiayel/yulinling_source_public -tags: -- blog -- documentation -thumbnail: /img/yulinling-tn.jpg -title: <span lang="zh-CN">语林灵</span> (Yulinling) ---- diff --git a/docs/content/taxonomies/displaying.md b/docs/content/taxonomies/displaying.md deleted file mode 100644 index 43dd48ba8..000000000 --- a/docs/content/taxonomies/displaying.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -aliases: -- /indexes/displaying/ -lastmod: 2016-06-29 -date: 2013-07-01 -linktitle: Displaying -menu: - main: - parent: taxonomy -next: /taxonomies/templates -prev: /taxonomies/usage -title: Displaying Taxonomies -weight: 20 -toc: true ---- - -There are four common ways you can display the data in your -taxonomies in addition to the automatic taxonomy pages created by hugo -using the [list templates](/templates/list/): - -1. For a given piece of content, you can list the terms attached -2. For a given piece of content, you can list other content with the same - term -3. You can list all terms for a taxonomy -4. You can list all taxonomies (with their terms) - -## 1. Displaying taxonomy terms assigned to this content - -Within your content templates, you may wish to display -the taxonomies that that piece of content is assigned to. - -Because we are leveraging the front matter system to -define taxonomies for content, the taxonomies assigned to -each content piece are located in the usual place -(.Params.`plural`). - -### Example - - <ul id="tags"> - {{ range .Params.tags }} - <li><a href="{{ "/tags/" | relLangURL }}{{ . | urlize }}">{{ . }}</a> </li> - {{ end }} - </ul> - -If you want to list taxonomies inline, you will have to take -care of optional plural ending in the title (if multiple taxonomies), -as well as commas. Let's say we have a taxonomy "directors" such as -`directors: [ "Joel Coen", "Ethan Coen" ]` in the TOML-format front matter. -To list such taxonomy use the following: - -### Example - - {{ if .Params.directors }} - <strong>Director{{ if gt (len .Params.directors) 1 }}s{{ end }}:</strong> - {{ range $index, $director := .Params.directors }}{{ if gt $index 0 }}, {{ end }}<a href="{{ "/directors/" | relURL }}{{ . | urlize }}">{{ . }}</a>{{ end }} - {{ end }} - -Alternatively, you may use the [delimit]({{< relref "templates/functions.md#delimit" >}}) -template function as a shortcut if the taxonomies should just be listed -with a separator. See {{< gh 2143 >}} on GitHub for discussion. - -## 2. Listing content with the same taxonomy term - -First, you may be asking why you would use this. If you are using a -taxonomy for something like a series of posts, this is exactly how you -would do it. It’s also an quick and dirty way to show some related -content. - - -### Example - - <ul> - {{ range .Site.Taxonomies.series.golang }} - <li><a href="{{ .Page.RelPermalink }}">{{ .Page.Title }}</a></li> - {{ end }} - </ul> - -## 3. Listing all content in a given taxonomy - -This would be very useful in a sidebar as “featured content”. You could -even have different sections of “featured content” by assigning -different terms to the content. - -### Example - - <section id="menu"> - <ul> - {{ range $key, $taxonomy := .Site.Taxonomies.featured }} - <li> {{ $key }} </li> - <ul> - {{ range $taxonomy.Pages }} - <li hugo-nav="{{ .RelPermalink}}"><a href="{{ .Permalink}}"> {{ .LinkTitle }} </a> </li> - {{ end }} - </ul> - {{ end }} - </ul> - </section> - - -## 4. Rendering a Site's Taxonomies - -If you wish to display the list of all keys for a taxonomy, you can find retrieve -them from the `.Site` variable which is available on every page. - -This may take the form of a tag cloud, a menu or simply a list. - -The following example displays all tag keys: - -### Example - - <ul id="all-tags"> - {{ range $name, $taxonomy := .Site.Taxonomies.tags }} - <li><a href="{{ "/tags/" | relLangURL }}{{ $name | urlize }}">{{ $name }}</a></li> - {{ end }} - </ul> - -### Complete Example -This example will list all taxonomies, each of their keys and all the content assigned to each key. - - <section> - <ul> - {{ range $taxonomyname, $taxonomy := .Site.Taxonomies }} - <li><a href="{{ "/" | relLangURL}}{{ $taxonomyname | urlize }}">{{ $taxonomyname }}</a> - <ul> - {{ range $key, $value := $taxonomy }} - <li> {{ $key }} </li> - <ul> - {{ range $value.Pages }} - <li hugo-nav="{{ .RelPermalink}}"><a href="{{ .Permalink}}"> {{ .LinkTitle }} </a> </li> - {{ end }} - </ul> - {{ end }} - </ul> - </li> - {{ end }} - </ul> - </section> diff --git a/docs/content/taxonomies/methods.md b/docs/content/taxonomies/methods.md deleted file mode 100644 index c5b9e755b..000000000 --- a/docs/content/taxonomies/methods.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -lastmod: 2015-12-23 -date: 2014-05-26 -linktitle: Structure & Methods -menu: - main: - parent: taxonomy -next: /extras/aliases -prev: /taxonomies/ordering -title: Using Taxonomies -weight: 75 ---- - -Hugo makes a set of values and methods available on the various Taxonomy structures. - -## Taxonomy Methods - -A Taxonomy is a `map[string]WeightedPages`. - -.Get(term) -: Returns the WeightedPages for a term. - -.Count(term) -: The number of pieces of content assigned to this term. - -.Alphabetical -: Returns an OrderedTaxonomy (slice) ordered by Term. - -.ByCount -: Returns an OrderedTaxonomy (slice) ordered by number of entries. - -## OrderedTaxonomy - -Since Maps are unordered, an OrderedTaxonomy is a special structure that has a defined order. - -```go -[]struct { - Name string - WeightedPages WeightedPages -} -``` - -Each element of the slice has: - -.Term -: The Term used. - -.WeightedPages -: A slice of Weighted Pages. - -.Count -: The number of pieces of content assigned to this term. - -.Pages -: All Pages assigned to this term. All [list methods](/templates/list/) are available to this. - -## WeightedPages - -WeightedPages is simply a slice of WeightedPage. - -```go -type WeightedPages []WeightedPage -``` - -.Count(term) -: The number of pieces of content assigned to this term. - -.Pages -: Returns a slice of pages, which then can be ordered using any of the [list methods](/templates/list/). diff --git a/docs/content/taxonomies/ordering.md b/docs/content/taxonomies/ordering.md deleted file mode 100644 index ac86bc69d..000000000 --- a/docs/content/taxonomies/ordering.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -aliases: -- /indexes/ordering/ -lastmod: 2015-12-23 -date: 2013-07-01 -linktitle: Ordering -menu: - main: - identifier: Ordering Taxonomies - parent: taxonomy -next: /taxonomies/methods -prev: /taxonomies/templates -title: Ordering Taxonomies -weight: 60 -toc: true ---- - -Hugo provides the ability to both: - - 1. Order the way the keys for a taxonomy are displayed - 2. Order the way taxonomyed content appears - - -## Ordering Taxonomies -Taxonomies can be ordered by either alphabetical key or by the number of content pieces assigned to that key. - -### Order Alphabetically Example - - <ul> - {{ $data := .Data }} - {{ range $key, $value := .Data.Taxonomy.Alphabetical }} - <li><a href="{{ .Site.LanguagePrefix }}/{{ $data.Plural }}/{{ $value.Name | urlize }}"> {{ $value.Name }} </a> {{ $value.Count }} </li> - {{ end }} - </ul> - -### Order by Popularity Example - - <ul> - {{ $data := .Data }} - {{ range $key, $value := .Data.Taxonomy.ByCount }} - <li><a href="{{ .Site.LanguagePrefix }}/{{ $data.Plural }}/{{ $value.Name | urlize }}"> {{ $value.Name }} </a> {{ $value.Count }} </li> - {{ end }} - </ul> - - -[See Also Taxonomy Lists]({{< relref "templates/list.md" >}}) - -## Ordering Content within Taxonomies - -Hugo uses both **Date** and **Weight** to order content within taxonomies. - -Each piece of content in Hugo can optionally be assigned a date. -It can also be assigned a weight for each taxonomy it is assigned to. - -When iterating over content within taxonomies the default sort is first by weight then by date. This means that if the weights for two pieces of content are the same, than the more recent content will be displayed first. The default weight for any piece of content is 0. - -### Assigning Weight - -Content can be assigned weight for each taxonomy that it's assigned to. - -```toml -+++ -tags = [ "a", "b", "c" ] -tags_weight = 22 -categories = ["d"] -title = "foo" -categories_weight = 44 -+++ -Front Matter with weighted tags and categories -``` - -The convention is `taxonomyname_weight`. - -In the above example, this piece of content has a weight of 22 which applies to the sorting when rendering the pages assigned to the "a", "b" and "c" values of the 'tag' taxonomy. - -It has also been assigned the weight of 44 when rendering the 'd' category. - -With this the same piece of content can appear in different positions in different taxonomies. - -Currently taxonomies only support the default ordering of content which is weight -> date. diff --git a/docs/content/taxonomies/overview.md b/docs/content/taxonomies/overview.md deleted file mode 100644 index a01e63980..000000000 --- a/docs/content/taxonomies/overview.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -aliases: -- /indexes/overview/ -- /doc/indexes/ -- /extras/indexes -lastmod: 2015-08-04 -date: 2013-07-01 -linktitle: Overview -menu: - main: - identifier: taxonomy overview - parent: taxonomy -next: /taxonomies/usage -prev: /templates/404 -title: Taxonomy Overview -weight: 10 ---- - -Hugo includes support for user-defined groupings of content called -taxonomies.[^1] Taxonomies give us a way to classify our content so we can -demonstrate relationships in a variety of logical ways. - -[^1]: Taxonomies were called *indexes* in Hugo prior to v0.11. - -The default taxonomies for Hugo are *tags* and *categories*. These -taxonomies are common to many website systems (e.g. WordPress, Drupal, -Jekyll). Unlike all of those systems, Hugo makes it trivial to customize -the taxonomies you will be using for your site however you wish. Another -good use for taxonomies is to group a set of posts into a series. Other -common uses would include *categories*, *tags*, *groups*, *series* and many -more. - -When taxonomies are used (and templates are provided), Hugo will -automatically create pages listing all of the taxonomies, their terms -and all of the content attached to those terms. - -## Definitions - -**Taxonomy:** A categorization that can be used to classify content - -**Term:** A key within that taxonomy - -**Value:** A piece of content assigned to that Term - -## Example - -For example, if I was writing about movies, I may want the following -taxonomies: - -* Actors -* Directors -* Studios -* Genre -* Year -* Awards - -I would then specify in each movie’s front-matter the specific terms for -each of those taxonomies. Hugo would then automatically create pages for -each Actor, Director, Studio, Genre, Year and Award listing all of the -Movies that matched that specific Actor, Director, etc. - - -### Taxonomy Organization - -Let’s use an example to demonstrate the different labels in action. -From the perspective of the taxonomy, it could be visualized as: - - Actor <- Taxonomy - Bruce Willis <- Term - The Six Sense <- Content - Unbreakable <- Content - Moonrise Kingdom <- Content - Samuel L. Jackson <- Term - Unbreakable <- Content - The Avengers <- Content - xXx <- Content - -From the perspective of the content, it would appear differently, though -the data and labels used are the same: - - Unbreakable <- Content - Actors <- Taxonomy - Bruce Willis <- Term - Samuel L. Jackson <- Term - Director <- Taxonomy - M. Night Shyamalan <- Term - ... - Moonrise Kingdom <- Content - Actors <- Taxonomy - Bruce Willis <- Term - Bill Murray <- Term - Director <- Taxonomy - Wes Anderson <- Term - ... - diff --git a/docs/content/taxonomies/templates.md b/docs/content/taxonomies/templates.md deleted file mode 100644 index 0a44d5b19..000000000 --- a/docs/content/taxonomies/templates.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -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. - -Both templates are covered in detail in the templates section. - -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. - -A [taxonomy terms template](/templates/terms/) is a template used to -generate the list of terms for a given template. - diff --git a/docs/content/taxonomies/usage.md b/docs/content/taxonomies/usage.md deleted file mode 100644 index 9c5dc2189..000000000 --- a/docs/content/taxonomies/usage.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -lastmod: 2015-12-23 -date: 2014-05-26 -linktitle: Usage -toc: true -menu: - main: - parent: taxonomy -next: /taxonomies/displaying -prev: /taxonomies/overview -title: Using Taxonomies -weight: 15 ---- - -## Defining taxonomies for a site - -Taxonomies must be defined in the site configuration before they can be -used throughout the site. You need to provide both the plural and -singular labels for each taxonomy. - -Here is an example configuration in TOML and YAML -that specifies three taxonomies (the default two, plus `series`). - -Notice the format is <code><strong>singular key</strong> = "<em>plural value</em>"</code> for TOML, -or <code><strong>singular key</strong>: "<em>plural value</em>"</code> for YAML: - -<table class="table"> -<thead> -<tr> -<th>config.toml excerpt:</th><th>config.yaml excerpt:</th> -</tr> -</thead> -<tbody> -<tr valign="top"> -<td><pre><code class="language-toml">[taxonomies] -tag = "tags" -category = "categories" -series = "series" -</code></pre></td> -<td><pre><code class="language-yaml">taxonomies: - tag: "tags" - category: "categories" - series: "series" -</code></pre></td> -</tr> -</tbody> -</table> - -## Assigning taxonomy values to content - -Once an taxonomy is defined at the site level, any piece of content -can be assigned to it regardless of content type or section. - -Assigning content to an taxonomy is done in the front matter. -Simply create a variable with the *plural* name of the taxonomy -and assign all terms you want to apply to this content. - -## Preserving taxonomy values - -By default, taxonomy names are hyphenated, lower-cased and normalized, and then -fixed and titleized on the archive page. - -However, if you want to have a taxonomy value with special characters -such as `Gérard Depardieu` instead of `Gerard Depardieu`, -you need to set the `preserveTaxonomyNames` [site configuration](/overview/configuration/) variable to `true`. -Hugo will then preserve special characters in taxonomy values -but will still titleize the values for titles and normalize them in URLs. - -Note that if you use `preserveTaxonomyNames` and intend to manually construct URLs to the archive pages, -you will need to pass the taxonomy values through the `urlize` template function. - -## Front Matter Example (in TOML) - -```toml -+++ -title = "Hugo: A fast and flexible static site generator" -tags = [ "Development", "Go", "fast", "Blogging" ] -categories = [ "Development" ] -series = [ "Go Web Dev" ] -slug = "hugo" -project_url = "https://github.com/gohugoio/hugo" -+++ -``` - -## Front Matter Example (in JSON) - -```json -{ - "title": "Hugo: A fast and flexible static site generator", - "tags": [ - "Development", - "Go", - "fast", - "Blogging" - ], - "categories" : [ - "Development" - ], - "series" : [ - "Go Web Dev" - ], - "slug": "hugo", - "project_url": "https://github.com/gohugoio/hugo" -} -``` - -## Add content file with frontmatter - -See [Source Organization]({{< relref "overview/source-directory.md#content-for-home-page-and-other-list-pages" >}}). diff --git a/docs/content/templates/404.md b/docs/content/templates/404.md deleted file mode 100644 index 0dc2e2c9c..000000000 --- a/docs/content/templates/404.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -aliases: -- /layout/404/ -lastmod: 2015-12-30 -date: 2013-08-21 -linktitle: "Custom 404 page" -menu: - main: - parent: layout -next: /taxonomies/overview -notoc: true -next: /templates/debugging -prev: /templates/sitemap -title: 404.html Templates -weight: 100 ---- - -When using Hugo with [GitHub Pages](http://pages.github.com/), you can provide -your own template for a [custom 404 error page](https://help.github.com/articles/custom-404-pages/) -by creating a 404.html template file in your `/layouts` folder. -When Hugo generates your site, the `404.html` file will be placed in the root. - -404 pages will have all the regular [page -variables](/layout/variables/) available to use in the templates. - -In addition to the standard page variables, the 404 page has access to -all site content accessible from `.Data.Pages`. - - ▾ layouts/ - 404.html - -## 404.html - -This is a basic example of a 404.html template: - - {{ partial "header.html" . }} - {{ partial "subheader.html" . }} - - <section id="main"> - <div> - <h1 id="title">{{ .Title }}</h1> - </div> - </section> - - {{ partial "footer.html" . }} - -### Automatic Loading - -Your 404.html file can be set to load automatically when a visitor enters a mistaken URL path, dependent upon the web serving environment you are using. For example: - -* _GitHub Pages_ - it's automatic. -* _Apache_ - one way is to specify `ErrorDocument 404 /404.html` in an `.htaccess` file in the root of your site. -* _Nginx_ - you might specify `error_page 404 = /404.html;` in your `nginx.conf` file. -* _Amazon AWS S3_ - when setting a bucket up for static web serving, you can specify the error file. -* _Caddy Server_ - using `errors { 404 /404.html }`. [Details here](https://caddyserver.com/docs/errors) diff --git a/docs/content/templates/ace.md b/docs/content/templates/ace.md deleted file mode 100644 index 1bd85796a..000000000 --- a/docs/content/templates/ace.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -aliases: -- /doc/templates/ace -- /layout/templates/ace -- /layout/ace/ -lastmod: 2015-08-04 -date: 2014-04-20 -linktitle: Ace templates -menu: - main: - parent: layout -next: /templates/functions -prev: /templates/go-templates -title: Ace Templates -weight: 17 ---- - -In addition to [Go templates](/templates/go-templates) and [Amber](/templates/amber) templates, Hugo supports the powerful Ace templates. - -For template documentation, follow the links from the [Ace project](https://github.com/yosssi/ace). - -* Ace templates must be named with the ace-suffix, e.g. `list.ace` -* It's possible to use both Go templates and Ace templates side-by-side, and include one into the other -* Full Go template syntax support, including all the useful helper funcs -* Partials can be included both with the Ace and the Go template syntax: - * `= include partials/foo.html .`[^ace-theme] - * `{{ partial "foo" . }}` - - -One noticeable difference between Ace and the others is the inheritance support through [base and inner templates](https://github.com/yosssi/ace/tree/master/examples/base_inner_template). - -In Hugo the base template will be chosen with the same ruleset as for [Go templates](/templates/blocks/). - - -.: -index.ace - -./blog: -single.ace -baseof.ace - -./_default: -baseof.ace list.ace single.ace single-baseof.ace -``` - -Some examples for the layout files above: - -* Home page: `./index.ace` + `./_default/baseof.ace` -* Single page in the `blog` section: `./blog/single.ace` + `./blog/baseof.ace` -* Single page in another section: `./_default/single.ace` + `./_default/single-baseof.ace` -* Taxonomy page in any section: `./_default/list.ace` + `./_default/baseof.ace` - -**Note:** In most cases one `baseof.ace` in `_default` will suffice. -**Note:** An Ace template without a reference to a base section, e.g. `= content`, will be handled as a standalone template. - - -[^ace-theme]: Note that the `html` suffix is needed, even if the filename is suffixed `ace`. This does not work from inside a theme, see [issue 763](https://github.com/gohugoio/hugo/issues/763). - diff --git a/docs/content/templates/amber.md b/docs/content/templates/amber.md deleted file mode 100644 index 2ba84353b..000000000 --- a/docs/content/templates/amber.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -aliases: -- /doc/templates/amber -- /layout/templates/amber -- /layout/amber/ -lastmod: 2015-11-05 -date: 2015-07-20 -linktitle: Amber templates -menu: - main: - parent: layout -next: /templates/functions -prev: /templates/go-templates -title: Amber Templates -weight: 18 ---- - -Amber templates are another template type which Hugo supports, in addition to [Go templates](/templates/go-templates) and [Ace templates]({{< relref "templates/ace.md" >}}) templates. - -For template documentation, follow the links from the [Amber project](https://github.com/eknkc/amber) - -* Amber templates must be named with the amber-suffix, e.g. `list.amber` -* Partials in Amber or HTML can be included with the Amber template syntax: - * `import ../partials/test.html ` - * `import ../partials/test_a.amber ` - - diff --git a/docs/content/templates/blocks.md b/docs/content/templates/blocks.md deleted file mode 100644 index f80a3d908..000000000 --- a/docs/content/templates/blocks.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -date: 2016-03-29T21:26:20-05:00 -menu: - main: - parent: layout -prev: /templates/views/ -next: /templates/partials/ -title: Block Templates -weight: 80 ---- - -The `block` keyword in Go templates allows you to define the outer shell of your pages one or more master template(s), filling in or overriding portions as necessary. - -## Base template lookup - -In version `0.20` Hugo introduced custom [Output Formats]({{< relref "extras/output-formats.md" >}}), all of which can have their own templates that also can use a base template if needed. - -This introduced two new terms relevant in the lookup of the templates, the media type's `Suffix` and the output format's `Name`. - -Given the above, Hugo tries to use the most specific base tamplate it finds: - -1. /layouts/_current-path_/_template-name_-baseof.[output-format].[suffix], e.g. list-baseof.amp.html. -1. /layouts/_current-path_/_template-name_-baseof.[suffix], e.g. list-baseof.html. -2. /layouts/_current-path_/baseof.[output-format].[suffix], e.g baseof.amp.html -2. /layouts/_current-path_/baseof.[suffix], e.g baseof.html -3. /layouts/_default/_template-name_-baseof.[output-format].[suffix] e.g. list-baseof.amp.html. -3. /layouts/_default/_template-name_-baseof.[suffix], e.g. list-baseof.html. -4. /layouts/_default/baseof.[output-format].[suffix] -4. /layouts/_default/baseof.[suffix] - -For each of the steps above, it will first look in the project, then, if theme is set, in the theme's layouts folder. Hugo picks the first base template found. - -As an example, with a site using the theme `exampletheme`, when rendering the section list for the section `post` for the output format `Calendar`. Hugo picks the `section/post.calendar.ics` as the template and this template has a `define` section that indicates it needs a base template. This is then the lookup order: - -1. `/layouts/section/post-baseof.calendar.ics` -1. `/layouts/section/post-baseof.ics` -2. `/themes/exampletheme/layouts/section/post-baseof.calendar.ics` -2. `/themes/exampletheme/layouts/section/post-baseof.ics` -3. `/layouts/section/baseof.calendar.ics` -3. `/layouts/section/baseof.ics` -4. `/themes/exampletheme/layouts/section/baseof.calendar.ics` -4. `/themes/exampletheme/layouts/section/baseof.ics` -5. `/layouts/_default/post-baseof.calendar.ics` -5. `/layouts/_default/post-baseof.ics` -6. `/themes/exampletheme/layouts/_default/post-baseof.calendar.ics` -6. `/themes/exampletheme/layouts/_default/post-baseof.ics` -7. `/layouts/_default/baseof.calendar.ics` -7. `/layouts/_default/baseof.ics` -8. `/themes/exampletheme/layouts/_default/baseof.calendar.ics` -8. `/themes/exampletheme/layouts/_default/baseof.ics` - - -## Define the base template - -Let's define a simple base template (`_default/baseof.html`), a shell from which all our pages will start. - -```html -<!DOCTYPE html> -<html> - <head> - <meta charset="utf-8"> - <title>{{ block "title" . }} - <!-- Blocks may include default content. --> - {{ .Site.Title }} - {{ end }}</title> - </head> - <body> - <!-- Code that all your templates share, like a header --> - - {{ block "main" . }} - <!-- The part of the page that begins to differ between templates --> - {{ end }} - - <!-- More shared code, perhaps a footer --> - </body> -</html> -``` - -## Overriding the base - -Your [default list template]({{< relref "templates/list.md" >}}) (`_default/list.html`) will inherit all of the code defined in the base template. It could then implement its own "main" block from the base template above like so: - -```html -<!-- Note the lack of Go's context "dot" when defining blocks --> -{{ define "main" }} - <h1>Posts</h1> - {{ range .Data.Pages }} - <article> - <h2>{{ .Title }}</h2> - {{ .Content }} - </article> - {{ end }} -{{ end }} -``` - -This replaces the contents of our (basically empty) "main" block with something useful for the list template. In this case, we didn't define a "title" block so the contents from our base template remain unchanged in lists. - -In our [default single template]({{< relref "templates/content.md" >}}) (`_default/single.html`), let's implement both blocks: - -```html -{{ define "title" }} - {{ .Title }} – {{ .Site.Title }} -{{ end }} -{{ define "main" }} - <h1>{{ .Title }}</h1> - {{ .Content }} -{{ end }} -``` - -This overrides both block areas from the base template with code unique to our single template. diff --git a/docs/content/templates/content.md b/docs/content/templates/content.md deleted file mode 100644 index 24d1782ad..000000000 --- a/docs/content/templates/content.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -aliases: -- /layout/content/ -lastmod: 2015-05-22 -date: 2013-07-01 -linktitle: Single Content -menu: - main: - parent: layout -next: /templates/list -prev: /templates/variables -title: Single Content Template -weight: 30 -toc: true ---- - -The primary view of content in Hugo is the single view. Hugo, for every -Markdown file provided, will render it with a single template. - - -## Which Template will be rendered? -Hugo uses a set of rules to figure out which template to use when -rendering a specific page. - -Hugo will use the following prioritized list. If a file isn’t present, -then the next one in the list will be used. This enables you to craft -specific layouts when you want to without creating more templates -than necessary. For most sites, only the `_default` file at the end of -the list will be needed. - -Users can specify the `type` and `layout` in the [front-matter](/content/front-matter/). `Section` -is determined based on the content file’s location. If `type` is provided, -it will be used instead of `section`. - -### Single Page - -* /layouts/`TYPE`/`LAYOUT`.html -* /layouts/`SECTION`/`LAYOUT`.html -* /layouts/`TYPE`/single.html -* /layouts/`SECTION`/single.html -* /layouts/_default/single.html -* /themes/`THEME`/layouts/`TYPE`/`LAYOUT`.html -* /themes/`THEME`/layouts/`SECTION`/`LAYOUT`.html -* /themes/`THEME`/layouts/`TYPE`/single.html -* /themes/`THEME`/layouts/`SECTION`/single.html -* /themes/`THEME`/layouts/_default/single.html - -## Example Single Template File - -Content pages are of the type "page" and have all the [page -variables](/layout/variables/) and [site -variables](/templates/variables/) available to use in the templates. - -In the following examples we have created two different content types as well as -a default content type. - -The default content template to be used in the event that a specific -template has not been provided for that type. The default type works the -same as the other types, but the directory must be called "\_default". - - ▾ layouts/ - ▾ _default/ - single.html - ▾ post/ - single.html - ▾ project/ - single.html - - -### post/single.html -This content template is used for [spf13.com](http://spf13.com/). -It makes use of [partial templates](/templates/partials/) - - {{ partial "header.html" . }} - {{ partial "subheader.html" . }} - {{ $baseURL := .Site.BaseURL }} - - <section id="main"> - <h1 id="title">{{ .Title }}</h1> - <div> - <article id="content"> - {{ .Content }} - </article> - </div> - </section> - - <aside id="meta"> - <div> - <section> - <h4 id="date"> {{ .Date.Format "Mon Jan 2, 2006" }} </h4> - <h5 id="wc"> {{ .FuzzyWordCount }} Words </h5> - </section> - <ul id="categories"> - {{ range .Params.topics }} - <li><a href="{{ $baseURL }}/topics/{{ . | urlize }}">{{ . }}</a> </li> - {{ end }} - </ul> - <ul id="tags"> - {{ range .Params.tags }} - <li> <a href="{{ $baseURL }}/tags/{{ . | urlize }}">{{ . }}</a> </li> - {{ end }} - </ul> - </div> - <div> - {{ if .Prev }} - <a class="previous" href="{{.Prev.Permalink}}"> {{.Prev.Title}}</a> - {{ end }} - {{ if .Next }} - <a class="next" href="{{.Next.Permalink}}"> {{.Next.Title}}</a> - {{ end }} - </div> - </aside> - - {{ partial "disqus.html" . }} - {{ partial "footer.html" . }} - - -### project/single.html -This content template is used for [spf13.com](http://spf13.com/). -It makes use of [partial templates](/templates/partials/) - - - {{ partial "header.html" . }} - {{ partial "subheader.html" . }} - {{ $baseURL := .Site.BaseURL }} - - <section id="main"> - <h1 id="title">{{ .Title }}</h1> - <div> - <article id="content"> - {{ .Content }} - </article> - </div> - </section> - - <aside id="meta"> - <div> - <section> - <h4 id="date"> {{ .Date.Format "Mon Jan 2, 2006" }} </h4> - <h5 id="wc"> {{ .FuzzyWordCount }} Words </h5> - </section> - <ul id="categories"> - {{ range .Params.topics }} - <li><a href="{{ $baseURL }}/topics/{{ . | urlize }}">{{ . }}</a> </li> - {{ end }} - </ul> - <ul id="tags"> - {{ range .Params.tags }} - <li> <a href="{{ $baseURL }}/tags/{{ . | urlize }}">{{ . }}</a> </li> - {{ end }} - </ul> - </div> - </aside> - - {{if isset .Params "project_url" }} - <div id="ribbon"> - <a href="{{ index .Params "project_url" }}" rel="me">Fork me on GitHub</a> - </div> - {{ end }} - - {{ partial "footer.html" . }} - -Notice how the project/single.html template uses an additional parameter unique -to this template. This doesn't need to be defined ahead of time. If the key is -present in the front matter than it can be used in the template. To -easily generate new content of this type with these keys ready use -[content archetypes](/content/archetypes/). diff --git a/docs/content/templates/debugging.md b/docs/content/templates/debugging.md deleted file mode 100644 index ae348f533..000000000 --- a/docs/content/templates/debugging.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -aliases: -- /doc/debugging/ -- /layout/debugging/ -lastmod: 2015-05-25 -date: 2015-05-22 -linktitle: Debugging -menu: - main: - parent: layout -prev: /templates/404 -title: Template Debugging -weight: 110 ---- - - -# Template Debugging - -Here are some snippets you can add to your template to answer some common questions. -These snippets use the `printf` function available in all Go templates. This function is -an alias to the Go function, [fmt.Printf](http://golang.org/pkg/fmt/). - - -### What variables are available in this context? - -You can use the template syntax, `$.`, to get the top-level template context -from anywhere in your template. This will print out all the values under, `.Site`. - - {{ printf "%#v" $.Site }} - -This will print out the value of `.Permalink`: - - {{ printf "%#v" .Permalink }} - -This will print out a list of all the variables scoped to the current context -(a.k.a. The dot, "`.`"). - - {{ printf "%#v" . }} - -When writing a [Homepage](/templates/homepage), what does one of the pages -you're looping through look like? - -``` -{{ range .Data.Pages }} - {{/* The context, ".", is now a Page */}} - {{ printf "%#v" . }} -{{ end }} -``` - -### Why do I have no variables defined? - -Check that you are passing variables in the `partial` function. For example - -``` -{{ partial "header" }} -``` - -will render the header partial, but the header partial will not have access to any variables. You need to pass variables explicitly. For example: - -``` -{{ partial "header" . }} -``` diff --git a/docs/content/templates/functions.md b/docs/content/templates/functions.md deleted file mode 100644 index 0c6968bd2..000000000 --- a/docs/content/templates/functions.md +++ /dev/null @@ -1,1088 +0,0 @@ ---- -aliases: -- /layout/functions/ -lastmod: 2015-09-20 -date: 2013-07-01 -linktitle: Functions -toc: true -menu: - main: - parent: layout -next: /templates/variables -prev: /templates/go-templates -title: Hugo Template Functions -weight: 20 ---- - -Hugo uses the excellent Go html/template library for its template engine. -It is an extremely lightweight engine that provides a very small amount of -logic. In our experience, it is just the right amount of logic to be able -to create a good static website. - -Go templates are lightweight but extensible. Hugo has added the following -functions to the basic template logic. - -(Go itself supplies built-in functions, including comparison operators -and other basic tools; these are listed in the -[Go template documentation](http://golang.org/pkg/text/template/#hdr-Functions).) - -## General - -### default -Checks whether a given value is set and returns a default value if it is not. -"Set" in this context means non-zero for numeric types and times; -non-zero length for strings, arrays, slices, and maps; -any boolean or struct value; or non-nil for any other types. - -e.g. - - {{ index .Params "font" | default "Roboto" }} → default is "Roboto" - {{ default "Roboto" (index .Params "font") }} → default is "Roboto" - -### delimit -Loops through any array, slice or map and returns a string of all the values separated by the delimiter. There is an optional third parameter that lets you choose a different delimiter to go between the last two values. -Maps will be sorted by the keys, and only a slice of the values will be returned, keeping a consistent output order. - -Works on [lists](/templates/list/), [taxonomies](/taxonomies/displaying/), [terms](/templates/terms/), [groups](/templates/list/) - -e.g. - - // Front matter - +++ - tags: [ "tag1", "tag2", "tag3" ] - +++ - - // Used anywhere in a template - Tags: {{ delimit .Params.tags ", " }} - - // Outputs Tags: tag1, tag2, tag3 - - // Example with the optional "last" parameter - Tags: {{ delimit .Params.tags ", " " and " }} - - // Outputs Tags: tag1, tag2 and tag3 - -### dict -Creates a dictionary `(map[string, interface{})`, expects parameters added in value:object fashion. -Invalid combinations like keys that are not strings or uneven number of parameters, will result in an exception thrown. -Useful for passing maps to partials when adding to a template. - -e.g. Pass into "foo.html" a map with the keys "important, content" - - {{$important := .Site.Params.SomethingImportant }} - {{range .Site.Params.Bar}} - {{partial "foo" (dict "content" . "important" $important)}} - {{end}} - -"foo.html" - - Important {{.important}} - {{.content}} - -or create a map on the fly to pass into - - {{partial "foo" (dict "important" "Smiles" "content" "You should do more")}} - - - -### slice - -`slice` allows you to create an array (`[]interface{}`) of all arguments that you pass to this function. - -One use case is the concatenation of elements in combination with `delimit`: - -```html -{{ delimit (slice "foo" "bar" "buzz") ", " }} -<!-- returns the string "foo, bar, buzz" --> -``` - - -### shuffle - -`shuffle` returns a random permutation of a given array or slice, e.g. - -```html -{{ shuffle (seq 1 5) }} -<!-- returns [2 5 3 1 4] --> - -{{ shuffle (slice "foo" "bar" "buzz") }} -<!-- returns [buzz foo bar] --> -``` - -### echoParam -Prints a parameter if it is set. - -e.g. `{{ echoParam .Params "project_url" }}` - - -### eq -Returns true if the parameters are equal. - -e.g. - - {{ if eq .Section "blog" }}current{{ end }} - - -### first -Slices an array to only the first _N_ elements. - -Works on [lists](/templates/list/), [taxonomies](/taxonomies/displaying/), [terms](/templates/terms/), [groups](/templates/list/) - -e.g. - - {{ range first 10 .Data.Pages }} - {{ .Render "summary" }} - {{ end }} - - -### jsonify -Encodes a given object to JSON. - -e.g. - - {{ dict "title" .Title "content" .Plain | jsonify }} - -### last -Slices an array to only the last _N_ elements. - -Works on [lists](/templates/list/), [taxonomies](/taxonomies/displaying/), [terms](/templates/terms/), [groups](/templates/list/) - -e.g. - - {{ range last 10 .Data.Pages }} - {{ .Render "summary" }} - {{ end }} - -### after -Slices an array to only the items after the <em>N</em>th item. Use this in combination -with `first` to use both halves of an array split at item _N_. - -Works on [lists](/templates/list/), [taxonomies](/taxonomies/displaying/), [terms](/templates/terms/), [groups](/templates/list/) - -e.g. - - {{ range after 10 .Data.Pages }} - {{ .Render "title" }} - {{ end }} - -### getenv -Returns the value of an environment variable. - -Takes a string containing the name of the variable as input. Returns -an empty string if the variable is not set, otherwise returns the -value of the variable. Note that in Unix-like environments, the -variable must also be exported in order to be seen by `hugo`. - -e.g. - - {{ getenv "HOME" }} - - -### in -Checks if an element is in an array (or slice) and returns a boolean. -The elements supported are strings, integers and floats (only float64 will match as expected). -In addition, it can also check if a substring exists in a string. - -e.g. - - {{ if in .Params.tags "Git" }}Follow me on GitHub!{{ end }} - -or - - {{ if in "this string contains a substring" "substring" }}Substring found!{{ end }} - - -### intersect -Given two arrays (or slices), this function will return the common elements in the arrays. -The elements supported are strings, integers and floats (only float64). - -A useful example of this functionality is a 'similar posts' block. -Create a list of links to posts where any of the tags in the current post match any tags in other posts. - -e.g. - - <ul> - {{ $page_link := .Permalink }} - {{ $tags := .Params.tags }} - {{ range .Site.Pages }} - {{ $page := . }} - {{ $has_common_tags := intersect $tags .Params.tags | len | lt 0 }} - {{ if and $has_common_tags (ne $page_link $page.Permalink) }} - <li><a href="{{ $page.Permalink }}">{{ $page.Title }}</a></li> - {{ end }} - {{ end }} - </ul> - - -### union -Given two arrays (or slices) A and B, this function will return a new array that contains the elements or objects that belong to either A or to B or to both. The elements supported are strings, integers and floats (only float64). - -``` -{{ union (slice 1 2 3) (slice 3 4 5) }} -<!-- returns [1 2 3 4 5] --> - -{{ union (slice 1 2 3) nil }} -<!-- returns [1 2 3] --> - -{{ union nil (slice 1 2 3) }} -<!-- returns [1 2 3] --> - -{{ union nil nil }} -<!-- returns an error because both arrays/slices have to be of the same type --> -``` - -### isset -Returns true if the parameter is set. -Takes either a slice, array or channel and an index or a map and a key as input. - -e.g. `{{ if isset .Params "project_url" }} {{ index .Params "project_url" }}{{ end }}` - -### seq - -Creates a sequence of integers. It's named and used as GNU's seq. - -Some examples: - -* `3` => `1, 2, 3` -* `1 2 4` => `1, 3` -* `-3` => `-1, -2, -3` -* `1 4` => `1, 2, 3, 4` -* `1 -2` => `1, 0, -1, -2` - -### sort -Sorts maps, arrays and slices, returning a sorted slice. -A sorted array of map values will be returned, with the keys eliminated. -There are two optional arguments, which are `sortByField` and `sortAsc`. -If left blank, sort will sort by keys (for maps) in ascending order. - -Works on [lists](/templates/list/), [taxonomies](/taxonomies/displaying/), [terms](/templates/terms/), [groups](/templates/list/) - -e.g. - - // Front matter - +++ - tags: [ "tag3", "tag1", "tag2" ] - +++ - - // Site config - +++ - [params.authors] - [params.authors.Derek] - "firstName" = "Derek" - "lastName" = "Perkins" - [params.authors.Joe] - "firstName" = "Joe" - "lastName" = "Bergevin" - [params.authors.Tanner] - "firstName" = "Tanner" - "lastName" = "Linsley" - +++ - - // Use default sort options - sort by key / ascending - Tags: {{ range sort .Params.tags }}{{ . }} {{ end }} - - // Outputs Tags: tag1 tag2 tag3 - - // Sort by value / descending - Tags: {{ range sort .Params.tags "value" "desc" }}{{ . }} {{ end }} - - // Outputs Tags: tag3 tag2 tag1 - - // Use default sort options - sort by value / descending - Authors: {{ range sort .Site.Params.authors }}{{ .firstName }} {{ end }} - - // Outputs Authors: Derek Joe Tanner - - // Use default sort options - sort by value / descending - Authors: {{ range sort .Site.Params.authors "lastName" "desc" }}{{ .lastName }} {{ end }} - - // Outputs Authors: Perkins Linsley Bergevin - - -### where -Filters an array to only elements containing a matching value for a given field. - -Works on [lists](/templates/list/), [taxonomies](/taxonomies/displaying/), [terms](/templates/terms/), [groups](/templates/list/) - -e.g. - - {{ range where .Data.Pages "Section" "post" }} - {{ .Content }} - {{ end }} - -It can be used with dot chaining second argument to refer a nested element of a value. - -e.g. - - // Front matter on some pages - +++ - series: golang - +++ - - {{ range where .Site.Pages "Params.series" "golang" }} - {{ .Content }} - {{ end }} - -It can also be used with an operator like `!=`, `>=`, `in` etc. Without an operator (like above), `where` compares a given field with a matching value in a way like `=` is specified. - -e.g. - - {{ range where .Data.Pages "Section" "!=" "post" }} - {{ .Content }} - {{ end }} - -Following operators are now available - -- `=`, `==`, `eq`: True if a given field value equals a matching value -- `!=`, `<>`, `ne`: True if a given field value doesn't equal a matching value -- `>=`, `ge`: True if a given field value is greater than or equal to a matching value -- `>`, `gt`: True if a given field value is greater than a matching value -- `<=`, `le`: True if a given field value is lesser than or equal to a matching value -- `<`, `lt`: True if a given field value is lesser than a matching value -- `in`: True if a given field value is included in a matching value. A matching value must be an array or a slice -- `not in`: True if a given field value isn't included in a matching value. A matching value must be an array or a slice -- `intersect`: True if a given field value that is a slice / array of strings or integers contains elements in common with the matching value. It follows the same rules as the intersect function. - -*`intersect` operator, e.g.:* - - {{ range where .Site.Pages ".Params.tags" "intersect" .Params.tags }} - {{ if ne .Permalink $.Permalink }} - {{ .Render "summary" }} - {{ end }} - {{ end }} - -*`where` and `first` can be stacked, e.g.:* - - {{ range first 5 (where .Data.Pages "Section" "post") }} - {{ .Content }} - {{ end }} - -### Unset field -Filter only work for set fields. To check whether a field is set or exist, use operand `nil`. - -This can be useful to filter a small amount of pages from a large pool. Instead of set field on all pages, you can set field on required pages only. - -Only following operators are available for `nil` - -- `=`, `==`, `eq`: True if the given field is not set. -- `!=`, `<>`, `ne`: True if the given field is set. - -e.g. - - {{ range where .Data.Pages ".Params.specialpost" "!=" nil }} - {{ .Content }} - {{ end }} - - -### uniq - -Takes in a slice or array and returns a slice with subsequent duplicate elements removed. - - {{ uniq (slice 1 2 3 2) }} - {{ slice 1 2 3 2 | uniq }} - <!-- both return [1 2 3] --> - -## Files - -### readDir - -Gets a directory listing from a directory relative to the current project working dir. - -So, If the project working dir has a single file named `README.txt`: - -`{{ range (readDir ".") }}{{ .Name }}{{ end }}` → "README.txt" - -### readFile -Reads a file from disk and converts it into a string. Note that the filename must be relative to the current project working dir. - So, if you have a file with the name `README.txt` in the root of your project with the content `Hugo Rocks!`: - - `{{readFile "README.txt"}}` → `"Hugo Rocks!"` - -### imageConfig -Parses the image and returns the height, width and color model. - -e.g. -``` -{{ with (imageConfig "favicon.ico") }} -favicon.ico: {{.Width}} x {{.Height}} -{{ end }} -``` - -## Math - -<table class="table table-bordered"> -<thead> -<tr> -<th>Function</th> -<th>Description</th> -<th>Example</th> -</tr> -</thead> - -<tbody> -<tr> -<td><code>add</code></td> -<td>Adds two integers.</td> -<td><code>{{add 1 2}}</code> → 3</td> -</tr> - -<tr> -<td><code>div</code></td> -<td>Divides two integers.</td> -<td><code>{{div 6 3}}</code> → 2</td> -</tr> - -<tr> -<td><code>mod</code></td> -<td>Modulus of two integers.</td> -<td><code>{{mod 15 3}}</code> → 0</td> -</tr> - -<tr> -<td><code>modBool</code></td> -<td>Boolean of modulus of two integers. <code>true</code> if modulus is 0.</td> -<td><code>{{modBool 15 3}}</code> → true</td> -</tr> - -<tr> -<td><code>mul</code></td> -<td>Multiplies two integers.</td> -<td><code>{{mul 2 3}}</code> → 6</td> -</tr> - -<tr> -<td><code>sub</code></td> -<td>Subtracts two integers.</td> -<td><code>{{sub 3 2}}</code> → 1</td> -</tr> - -</tbody> -</table> - -## Numbers - -### int - -Creates an `int`. - -e.g. - -* `{{ int "123" }}` → 123 - -### lang.NumFmt - -`NumFmt` formats a number with the given precision using the *decimal*, -*grouping*, and *negative* options. The `options` parameter is a -string consisting of `<negative> <decimal> <grouping>`. The default -`options` value is `- . ,`. - -Note that numbers are rounded up at 5 or greater. -So, with precision set to 0, 1.5 becomes `2`, and 1.4 becomes `1`. - -``` -{{ lang.NumFmt 2 12345.6789 }} → 12,345.68 -{{ lang.NumFmt 2 12345.6789 "- , ." }} → 12.345,68 -{{ lang.NumFmt 0 -12345.6789 "- . ," }} → -12,346 -{{ lang.NumFmt 6 -12345.6789 "- ." }} → -12345.678900 -{{ -98765.4321 | lang.NumFmt 2 }} → -98,765.43 -``` - -## Strings - -### printf - -Format a string using the standard `fmt.Sprintf` function. See [the go -doc](https://golang.org/pkg/fmt/) for reference. -A -e.g., `{{ i18n ( printf "combined_%s" $var ) }}` or `{{ printf "formatted %.2f" 3.1416 }}` - -### chomp -Removes any trailing newline characters. Useful in a pipeline to remove newlines added by other processing (including `markdownify`). - -e.g., `{{chomp "<p>Blockhead</p>\n"}}` → `"<p>Blockhead</p>"` - - -### dateFormat -Converts the textual representation of the datetime into the other form or returns it of Go `time.Time` type value. -These are formatted with the layout string. - -e.g. `{{ dateFormat "Monday, Jan 2, 2006" "2015-01-21" }}` → "Wednesday, Jan 21, 2015" - - -### emojify - -Runs the string through the Emoji emoticons processor. The result will be declared as "safe" so Go templates will not filter it. - -See the [Emoji cheat sheet](http://www.emoji-cheat-sheet.com/) for available emoticons. - -e.g. `{{ "I :heart: Hugo" | emojify }}` - -### highlight -Takes a string of code and a language, uses Pygments to return the syntax highlighted code in HTML. -Used in the [highlight shortcode](/extras/highlighting/). - -### htmlEscape -HtmlEscape returns the given string with the critical reserved HTML codes escaped, -such that `&` becomes `&` and so on. It escapes only: `<`, `>`, `&`, `'` and `"`. - -Bear in mind that, unless content is passed to `safeHTML`, output strings are escaped -usually by the processor anyway. - -e.g. -`{{ htmlEscape "Hugo & Caddy > Wordpress & Apache" }} → "Hugo & Caddy > Wordpress & Apache"` - -### htmlUnescape -HtmlUnescape returns the given string with html escape codes un-escaped. This -un-escapes more codes than `htmlEscape` escapes, including `#` codes and pre-UTF8 -escapes for accented characters. It defers completely to the Go `html.UnescapeString` -function, so functionality is consistent with that codebase. - -Remember to pass the output of this to `safeHTML` if fully unescaped characters -are desired, or the output will be escaped again as normal. - -e.g. -`{{ htmlUnescape "Hugo & Caddy > Wordpress & Apache" }} → "Hugo & Caddy > Wordpress & Apache"` - -### humanize -Humanize returns the humanized version of an argument with the first letter capitalized. -If the input is either an int64 value or the string representation of an integer, humanize returns the number with the proper ordinal appended. - -e.g. -``` -{{humanize "my-first-post"}} → "My first post" -{{humanize "myCamelPost"}} → "My camel post" -{{humanize "52"}} → "52nd" -{{humanize 103}} → "103rd" -``` - - -### lower -Converts all characters in string to lowercase. - -e.g. `{{lower "BatMan"}}` → "batman" - - -### markdownify - -Runs the string through the Markdown processor. The result will be declared as "safe" so Go templates will not filter it. - -e.g. `{{ .Title | markdownify }}` - -### plainify - -Strips any HTML and returns the plain text version. - -e.g. `{{ "<b>BatMan</b>" | plainify }}` → "BatMan" - -### pluralize -Pluralize the given word with a set of common English pluralization rules. - -e.g. `{{ "cat" | pluralize }}` → "cats" - -### findRE -Returns a list of strings that match the regular expression. By default all matches will be included. The number of matches can be limited with an optional third parameter. - -The example below returns a list of all second level headers (`<h2>`) in the content: - - {{ findRE "<h2.*?>(.|\n)*?</h2>" .Content }} - -We can limit the number of matches in that list with a third parameter. Let's say we want to have at most one match (or none if no substring matched): - - {{ findRE "<h2.*?>(.|\n)*?</h2>" .Content 1 }} - <!-- returns ["<h2 id="#foo">Foo</h2>"] --> - -`findRE` allows us to build an automatically generated table of contents that could be used for a simple scrollspy: - - {{ $headers := findRE "<h2.*?>(.|\n)*?</h2>" .Content }} - - {{ if ge (len $headers) 1 }} - <ul> - {{ range $headers }} - <li> - <a href="#{{ . | plainify | urlize }}"> - {{ . | plainify }} - </a> - </li> - {{ end }} - </ul> - {{ end }} - -First, we try to find all second-level headers and generate a list if at least one header was found. `plainify` strips the HTML and `urlize` converts the header into a valid URL. - -### replace -Replaces all occurrences of the search string with the replacement string. - -e.g. `{{ replace "Batman and Robin" "Robin" "Catwoman" }}` → "Batman and Catwoman" - - -### replaceRE -Replaces all occurrences of a regular expression with the replacement pattern. - -e.g. `{{ replaceRE "^https?://([^/]+).*" "$1" "http://gohugo.io/docs" }}` → "gohugo.io" -e.g. `{{ "http://gohugo.io/docs" | replaceRE "^https?://([^/]+).*" "$1" }}` → "gohugo.io" - - -### safeHTML -Declares the provided string as a "safe" HTML document fragment -so Go html/template will not filter it. It should not be used -for HTML from a third-party, or HTML with unclosed tags or comments. - -Example: Given a site-wide `config.toml` that contains this line: - - copyright = "© 2015 Jane Doe. <a href=\"http://creativecommons.org/licenses/by/4.0/\">Some rights reserved</a>." - -`{{ .Site.Copyright | safeHTML }}` would then output: - -> © 2015 Jane Doe. <a href="http://creativecommons.org/licenses/by/4.0/">Some rights reserved</a>. - -However, without the `safeHTML` function, html/template assumes -`.Site.Copyright` to be unsafe, escaping all HTML tags, -rendering the whole string as plain-text like this: - -<blockquote> -<p>© 2015 Jane Doe. <a href="http://creativecommons.org/licenses/by/4.0/">Some rights reserved</a>.</p> -</blockquote> - -### safeHTMLAttr -Declares the provided string as a "safe" HTML attribute -from a trusted source, for example, ` dir="ltr"`, -so Go html/template will not filter it. - -Example: Given a site-wide `config.toml` that contains this menu entry: - - [[menu.main]] - name = "IRC: #golang at freenode" - url = "irc://irc.freenode.net/#golang" - -* `<a href="{{ .URL }}">` ⇒ `<a href="#ZgotmplZ">` (Bad!) -* `<a {{ printf "href=%q" .URL | safeHTMLAttr }}>` ⇒ `<a href="irc://irc.freenode.net/#golang">` (Good!) - -### safeCSS -Declares the provided string as a known "safe" CSS string -so Go html/templates will not filter it. -"Safe" means CSS content that matches any of: - -1. The CSS3 stylesheet production, such as `p { color: purple }`. -2. The CSS3 rule production, such as `a[href=~"https:"].foo#bar`. -3. CSS3 declaration productions, such as `color: red; margin: 2px`. -4. The CSS3 value production, such as `rgba(0, 0, 255, 127)`. - -Example: Given `style = "color: red;"` defined in the front matter of your `.md` file: - -* `<p style="{{ .Params.style | safeCSS }}">…</p>` ⇒ `<p style="color: red;">…</p>` (Good!) -* `<p style="{{ .Params.style }}">…</p>` ⇒ `<p style="ZgotmplZ">…</p>` (Bad!) - -Note: "ZgotmplZ" is a special value that indicates that unsafe content reached a -CSS or URL context. - -### safeJS - -Declares the provided string as a known "safe" Javascript string so Go -html/templates will not escape it. "Safe" means the string encapsulates a known -safe EcmaScript5 Expression, for example, `(x + y * z())`. Template authors -are responsible for ensuring that typed expressions do not break the intended -precedence and that there is no statement/expression ambiguity as when passing -an expression like `{ foo:bar() }\n['foo']()`, which is both a valid Expression -and a valid Program with a very different meaning. - -Example: Given `hash = "619c16f"` defined in the front matter of your `.md` file: - -* `<script>var form_{{ .Params.hash | safeJS }};…</script>` ⇒ `<script>var form_619c16f;…</script>` (Good!) -* `<script>var form_{{ .Params.hash }};…</script>` ⇒ `<script>var form_"619c16f";…</script>` (Bad!) - -### singularize -Singularize the given word with a set of common English singularization rules. - -e.g. `{{ "cats" | singularize }}` → "cat" - -### slicestr - -Slicing in `slicestr` is done by specifying a half-open range with two indices, `start` and `end`. -For example, 1 and 4 creates a slice including elements 1 through 3. -The `end` index can be omitted; it defaults to the string's length. - -e.g. - -* `{{slicestr "BatMan" 3}}` → "Man" -* `{{slicestr "BatMan" 0 3}}` → "Bat" - -### truncate - -Truncate a text to a max length without cutting words or leaving unclosed HTML tags. Since Go templates are HTML-aware, truncate will handle normal strings vs HTML strings intelligently. It's important to note that if you have a raw string that contains HTML tags that you want treated as HTML, you will need to convert the string to HTML using the safeHTML template function before sending the value to truncate; otherwise, the HTML tags will be escaped by truncate. - -e.g. - -* `{{ "this is a text" | truncate 10 " ..." }}` → `this is a ...` -* `{{ "<em>Keep my HTML</em>" | safeHTML | truncate 10 }}` → `<em>Keep my …</em>` -* `{{ "With [Markdown](#markdown) inside." | markdownify | truncate 10 }}` → `With <a href='#markdown'>Markdown …</a>` - -### split - -Split a string into substrings separated by a delimiter. - -e.g. - -* `{{split "tag1,tag2,tag3" "," }}` → ["tag1" "tag2" "tag3"] - -### string - -Creates a `string`. - -e.g. - -* `{{string "BatMan"}}` → "BatMan" - -### substr - -Extracts parts of a string, beginning at the character at the specified -position, and returns the specified number of characters. - -It normally takes two parameters: `start` and `length`. -It can also take one parameter: `start`, i.e. `length` is omitted, in which case -the substring starting from start until the end of the string will be returned. - -To extract characters from the end of the string, use a negative start number. - -In addition, borrowing from the extended behavior described at http://php.net/substr, -if `length` is given and is negative, then that many characters will be omitted from -the end of string. - -e.g. - -* `{{substr "BatMan" 0 -3}}` → "Bat" -* `{{substr "BatMan" 3 3}}` → "Man" - -### hasPrefix - -HasPrefix tests whether a string begins with prefix. - -* `{{ hasPrefix "Hugo" "Hu" }}` → true - -### title -Converts all characters in string to titlecase. - -e.g. `{{title "BatMan"}}` → "Batman" - - -### trim -Returns a slice of the string with all leading and trailing characters contained in cutset removed. - -e.g. `{{ trim "++Batman--" "+-" }}` → "Batman" - - -### upper -Converts all characters in string to uppercase. - -e.g. `{{upper "BatMan"}}` → "BATMAN" - - -### countwords - -`countwords` tries to convert the passed content to a string and counts each word -in it. The template functions works similar to [.WordCount]({{< relref "templates/variables.md#page-variables" >}}). - -```html -{{ "Hugo is a static site generator." | countwords }} -<!-- outputs a content length of 6 words. --> -``` - - -### countrunes - -Alternatively to counting all words , `countrunes` determines the number of runes in the content and excludes any whitespace. This can become useful if you have to deal with -CJK-like languages. - -```html -{{ "Hello, 世界" | countrunes }} -<!-- outputs a content length of 8 runes. --> -``` - -### md5 - -`md5` hashes the given input and returns its MD5 checksum. - -```html -{{ md5 "Hello world, gophers!" }} -<!-- returns the string "b3029f756f98f79e7f1b7f1d1f0dd53b" --> -``` - -This can be useful if you want to use Gravatar for generating a unique avatar: - -```html -<img src="https://www.gravatar.com/avatar/{{ md5 "your@email.com" }}?s=100&d=identicon"> -``` - - -### sha1 - -`sha1` hashes the given input and returns its SHA1 checksum. - -```html -{{ sha1 "Hello world, gophers!" }} -<!-- returns the string "c8b5b0e33d408246e30f53e32b8f7627a7a649d4" --> -``` - - -### sha256 - -`sha256` hashes the given input and returns its SHA256 checksum. - -```html -{{ sha256 "Hello world, gophers!" }} -<!-- returns the string "6ec43b78da9669f50e4e422575c54bf87536954ccd58280219c393f2ce352b46" --> -``` - - -## Internationalization - -### i18n - -This translates a piece of content based on your `i18n/en-US.yaml` -(and friends) files. You can use the [go-i18n](https://github.com/nicksnyder/go-i18n) tools to manage your translations. The translations can exist in both the theme and at the root of your repository. - -e.g.: `{{ i18n "translation_id" }}` - -For more information about string translations, see [Translation of strings]({{< relref "content/multilingual.md#translation-of-strings">}}). - -### T - -`T` is an alias to `i18n`. E.g. `{{ T "translation_id" }}`. - -## Times - -### time - -`time` converts a timestamp string into a [`time.Time`](https://godoc.org/time#Time) structure so you can access its fields. E.g. - -* `{{ time "2016-05-28" }}` → "2016-05-28T00:00:00Z" -* `{{ (time "2016-05-28").YearDay }}` → 149 -* `{{ mul 1000 (time "2016-05-28T10:30:00.00+10:00").Unix }}` → 1464395400000 (Unix time in milliseconds) - -### now - -`now` returns the current local time as a [`time.Time`](https://godoc.org/time#Time). - -## URLs -### absLangURL, relLangURL -These are similar to the `absURL` and `relURL` relatives below, but will add the correct language prefix when the site is configured with more than one language. - -So for a site `baseURL` set to `http://mysite.com/hugo/` and the current language is `en`: - -* `{{ "blog/" | absLangURL }}` → "http://mysite.com/hugo/en/blog/" -* `{{ "blog/" | relLangURL }}` → "/hugo/en/blog/" - -### absURL, relURL - -Both `absURL` and `relURL` considers the configured value of `baseURL`, so given a `baseURL` set to `http://mysite.com/hugo/`: - -* `{{ "mystyle.css" | absURL }}` → "http://mysite.com/hugo/mystyle.css" -* `{{ "mystyle.css" | relURL }}` → "/hugo/mystyle.css" -* `{{ "http://gohugo.io/" | relURL }}` → "http://gohugo.io/" -* `{{ "http://gohugo.io/" | absURL }}` → "http://gohugo.io/" - -The last two examples may look funky, but is useful if you, say, have a list of images, some of them hosted externally, some locally: - -``` -<script type="application/ld+json"> -{ - "@context" : "http://schema.org", - "@type" : "BlogPosting", - "image" : {{ apply .Params.images "absURL" "." }} -} -</script> -``` - -The above also exploits the fact that the Go template parser JSON-encodes objects inside `script` tags. - - - -**Note:** These functions are smart about missing slashes, but will not add one to the end if not present. - - -### ref, relref -Looks up a content page by relative path or logical name to return the permalink (`ref`) or relative permalink (`relref`). Requires a `Page` object (usually satisfied with `.`). Used in the [`ref` and `relref` shortcodes]({{% ref "extras/crossreferences.md" %}}). - -e.g. {{ ref . "about.md" }} - -### safeURL -Declares the provided string as a "safe" URL or URL substring (see [RFC 3986][]). -A URL like `javascript:checkThatFormNotEditedBeforeLeavingPage()` from a trusted -source should go in the page, but by default dynamic `javascript:` URLs are -filtered out since they are a frequently exploited injection vector. - -[RFC 3986]: http://tools.ietf.org/html/rfc3986 - -Without `safeURL`, only the URI schemes `http:`, `https:` and `mailto:` -are considered safe by Go. If any other URI schemes, e.g. `irc:` and -`javascript:`, are detected, the whole URL would be replaced with -`#ZgotmplZ`. This is to "defang" any potential attack in the URL, -rendering it useless. - -Example: Given a site-wide `config.toml` that contains this menu entry: - - [[menu.main]] - name = "IRC: #golang at freenode" - url = "irc://irc.freenode.net/#golang" - -The following template: - - <ul class="sidebar-menu"> - {{ range .Site.Menus.main }} - <li><a href="{{ .URL }}">{{ .Name }}</a></li> - {{ end }} - </ul> - -would produce `<li><a href="#ZgotmplZ">IRC: #golang at freenode</a></li>` -for the `irc://…` URL. - -To fix this, add ` | safeURL` after `.URL` on the 3rd line, like this: - - <li><a href="{{ .URL | safeURL }}">{{ .Name }}</a></li> - -With this change, we finally get `<li><a href="irc://irc.freenode.net/#golang">IRC: #golang at freenode</a></li>` -as intended. - - -### urlize -Takes a string and sanitizes it for usage in URLs, converts spaces to "-". - -e.g. `<a href="/tags/{{ . | urlize }}">{{ . }}</a>` - - -### querify - -Takes a set of key-value pairs and returns a [query string](https://en.wikipedia.org/wiki/Query_string) that can be appended to a URL. E.g. - - <a href="https://www.google.com?{{ (querify "q" "test" "page" 3) | safeURL }}">Search</a> - -will be rendered as - - <a href="https://www.google.com?page=3&q=test">Search</a> - - -## Content Views - -### Render -Takes a view to render the content with. The view is an alternate layout, and should be a file name that points to a template in one of the locations specified in the documentation for [Content Views](/templates/views). - -This function is only available on a piece of content, and in list context. - -This example could render a piece of content using the content view located at `/layouts/_default/summary.html`: - - {{ range .Data.Pages }} - {{ .Render "summary"}} - {{ end }} - - - -## Advanced - -### apply - -Given a map, array, or slice, returns a new slice with a function applied over it. Expects at least three parameters, depending on the function being applied. The first parameter is the sequence to operate on; the second is the name of the function as a string, which must be in the Hugo function map (generally, it is these functions documented here). After that, the parameters to the applied function are provided, with the string `"."` standing in for each element of the sequence the function is to be applied against. An example is in order: - - +++ - names: [ "Derek Perkins", "Joe Bergevin", "Tanner Linsley" ] - +++ - - {{ apply .Params.names "urlize" "." }} → [ "derek-perkins", "joe-bergevin", "tanner-linsley" ] - -This is roughly equivalent to: - - {{ range .Params.names }}{{ . | urlize }}{{ end }} - -However, it isn’t possible to provide the output of a range to the `delimit` function, so you need to `apply` it. A more complete example should explain this. Let's say you have two partials for displaying tag links in a post, "post/tag/list.html" and "post/tag/link.html", as shown below. - - <!-- post/tag/list.html --> - {{ with .Params.tags }} - <div class="tags-list"> - Tags: - {{ $len := len . }} - {{ if eq $len 1 }} - {{ partial "post/tag/link" (index . 0) }} - {{ else }} - {{ $last := sub $len 1 }} - {{ range first $last . }} - {{ partial "post/tag/link" . }}, - {{ end }} - {{ partial "post/tag/link" (index . $last) }} - {{ end }} - </div> - {{ end }} - - - <!-- post/tag/link.html --> - <a class="post-tag post-tag-{{ . | urlize }}" href="/tags/{{ . | urlize }}">{{ . }}</a> - -This works, but the complexity of "post/tag/list.html" is fairly high; the Hugo template needs to perform special behaviour for the case where there’s only one tag, and it has to treat the last tag as special. Additionally, the tag list will be rendered something like "Tags: tag1 , tag2 , tag3" because of the way that the HTML is generated and it is interpreted by a browser. - -This is Hugo. We have a better way. If this were your "post/tag/list.html" instead, all of those problems are fixed automatically (this first version separates all of the operations for ease of reading; the combined version will be shown after the explanation). - - <!-- post/tag/list.html --> - {{ with .Params.tags }} - <div class="tags-list"> - Tags: - {{ $sort := sort . }} - {{ $links := apply $sort "partial" "post/tag/link" "." }} - {{ $clean := apply $links "chomp" "." }} - {{ delimit $clean ", " }} - </div> - {{ end }} - -In this version, we are now sorting the tags, converting them to links with "post/tag/link.html", cleaning off stray newlines, and joining them together in a delimited list for presentation. That can also be written as: - - <!-- post/tag/list.html --> - {{ with .Params.tags }} - <div class="tags-list"> - Tags: - {{ delimit (apply (apply (sort .) "partial" "post/tag/link" ".") "chomp" ".") ", " }} - </div> - {{ end }} - -`apply` does not work when receiving the sequence as an argument through a pipeline. - -*** - -### base64Encode and base64Decode - -`base64Encode` and `base64Decode` let you easily decode content with a base64 encoding and vice versa through pipes. Let's take a look at an example: - - - {{ "Hello world" | base64Encode }} - <!-- will output "SGVsbG8gd29ybGQ=" and --> - - {{ "SGVsbG8gd29ybGQ=" | base64Decode }} - <!-- becomes "Hello world" again. --> - -You can also pass other datatypes as argument to the template function which tries -to convert them. Now we use an integer instead of a string: - - - {{ 42 | base64Encode | base64Decode }} - <!-- will output "42". Both functions always return a string. --> - -**Tip:** Using base64 to decode and encode becomes really powerful if we have to handle -responses of APIs. - - {{ $resp := getJSON "https://api.github.com/repos/gohugoio/hugo/readme" }} - {{ $resp.content | base64Decode | markdownify }} - -The response of the GitHub API contains the base64-encoded version of the [README.md](https://github.com/gohugoio/hugo/blob/master/README.md) in the Hugo repository. Now we can decode it and parse the Markdown. The final output will look similar to the rendered version on GitHub. - -*** - -### partialCached - -See [Template Partials]({{< relref "templates/partials.md#cached-partials" >}}) for an explanation of the `partialCached` template function. - - -## .Site.GetPage -Every `Page` has a `Kind` attribute that shows what kind of page it is. While this attribute can be used to list pages of a certain `kind` using `where`, often it can be useful to fetch a single page by its path. - -`GetPage` looks up an index page of a given `Kind` and `path`. This method may support regular pages in the future, but currently it is a convenient way of getting the index pages, such as the home page or a section, from a template: - - {{ with .Site.GetPage "section" "blog" }}{{ .Title }}{{ end }} - -This method wil return `nil` when no page could be found, so the above will not print anything if the blog section isn't found. - -The valid page kinds are: *home, section, taxonomy and taxonomyTerm.* diff --git a/docs/content/templates/go-templates.md b/docs/content/templates/go-templates.md deleted file mode 100644 index bb7c71606..000000000 --- a/docs/content/templates/go-templates.md +++ /dev/null @@ -1,443 +0,0 @@ ---- -aliases: -- /layout/go-templates/ -- /layouts/go-templates/ -lastmod: 2015-11-30 -date: 2013-07-01 -menu: - main: - parent: layout -next: /templates/ace -prev: /templates/overview -title: Go Template Primer -weight: 15 -toc: true ---- - -Hugo uses the excellent [Go][] [html/template][gohtmltemplate] library for -its template engine. It is an extremely lightweight engine that provides a very -small amount of logic. In our experience it is just the right amount of -logic to be able to create a good static website. If you have used other -template systems from different languages or frameworks, you will find a lot of -similarities in Go templates. - -This document is a brief primer on using Go templates. The [Go docs][gohtmltemplate] -go into more depth and cover features that aren't mentioned here. - -## Introduction to Go Templates - -Go templates provide an extremely simple template language. It adheres to the -belief that only the most basic of logic belongs in the template or view layer. -One consequence of this simplicity is that Go templates parse very quickly. - -A unique characteristic of Go templates is they are content aware. Variables and -content will be sanitized depending on the context of where they are used. More -details can be found in the [Go docs][gohtmltemplate]. - -## Basic Syntax - -Go lang templates are HTML files with the addition of variables and -functions. - -**Go variables and functions are accessible within {{ }}** - -Accessing a predefined variable "foo": - - {{ foo }} - -**Parameters are separated using spaces** - -Calling the `add` function with input of 1, 2: - - {{ add 1 2 }} - -**Methods and fields are accessed via dot notation** - -Accessing the Page Parameter "bar" - - {{ .Params.bar }} - -**Parentheses can be used to group items together** - - {{ if or (isset .Params "alt") (isset .Params "caption") }} Caption {{ end }} - - -## Variables - -Each Go template has a struct (object) made available to it. In Hugo, each -template is passed page struct. More details are available on the -[variables](/layout/variables/) page. - -A variable is accessed by referencing the variable name. - - <title>{{ .Title }}</title> - -Variables can also be defined and referenced. - - {{ $address := "123 Main St."}} - {{ $address }} - - -## Functions - -Go template ships with a few functions which provide basic functionality. The Go -template system also provides a mechanism for applications to extend the -available functions with their own. [Hugo template -functions](/layout/functions/) provide some additional functionality we believe -are useful for building websites. Functions are called by using their name -followed by the required parameters separated by spaces. Template -functions cannot be added without recompiling Hugo. - -**Example 1: Adding numbers** - - {{ add 1 2 }} - -**Example 2: Comparing numbers** - - {{ lt 1 2 }} - -(There are more boolean operators, detailed in the -[template documentation](http://golang.org/pkg/text/template/#hdr-Functions).) - -## Includes - -When including another template, you will pass to it the data it will be -able to access. To pass along the current context, please remember to -include a trailing dot. The templates location will always be starting at -the /layout/ directory within Hugo. - -**Example:** - - {{ template "partials/header.html" . }} - -And, starting with Hugo v0.12, you may also use the `partial` call -for [partial templates](/templates/partials/): - - {{ partial "header.html" . }} - - -## Logic - -Go templates provide the most basic iteration and conditional logic. - -### Iteration - -Just like in Go, the Go templates make heavy use of `range` to iterate over -a map, array or slice. The following are different examples of how to use -range. - -**Example 1: Using Context** - - {{ range array }} - {{ . }} - {{ end }} - -**Example 2: Declaring value variable name** - - {{range $element := array}} - {{ $element }} - {{ end }} - -**Example 2: Declaring key and value variable name** - - {{range $index, $element := array}} - {{ $index }} - {{ $element }} - {{ end }} - -### Conditionals - -`if`, `else`, `with`, `or` & `and` provide the framework for handling conditional -logic in Go Templates. Like `range`, each statement is closed with `end`. - -Go Templates treat the following values as false: - -* false -* 0 -* any array, slice, map, or string of length zero - -**Example 1: `if`** - - {{ if isset .Params "title" }}<h4>{{ index .Params "title" }}</h4>{{ end }} - -**Example 2: `if` … `else`** - - {{ if isset .Params "alt" }} - {{ index .Params "alt" }} - {{else}} - {{ index .Params "caption" }} - {{ end }} - -**Example 3: `and` & `or`** - - {{ if and (or (isset .Params "title") (isset .Params "caption")) (isset .Params "attr")}} - -**Example 4: `with`** - -An alternative way of writing "`if`" and then referencing the same value -is to use "`with`" instead. `with` rebinds the context `.` within its scope, -and skips the block if the variable is absent. - -The first example above could be simplified as: - - {{ with .Params.title }}<h4>{{ . }}</h4>{{ end }} - -**Example 5: `if` … `else if`** - - {{ if isset .Params "alt" }} - {{ index .Params "alt" }} - {{ else if isset .Params "caption" }} - {{ index .Params "caption" }} - {{ end }} - -## Pipes - -One of the most powerful components of Go templates is the ability to -stack actions one after another. This is done by using pipes. Borrowed -from Unix pipes, the concept is simple, each pipeline's output becomes the -input of the following pipe. - -Because of the very simple syntax of Go templates, the pipe is essential -to being able to chain together function calls. One limitation of the -pipes is that they only can work with a single value and that value -becomes the last parameter of the next pipeline. - -A few simple examples should help convey how to use the pipe. - -**Example 1:** - - {{ shuffle (seq 1 5) }} - -is the same as - - {{ (seq 1 5) | shuffle }} - -**Example 2:** - - {{ index .Params "disqus_url" | html }} - -Access the page parameter called "disqus_url" and escape the HTML. - -The `index` function is a [Go][] built-in, and you can read about it [here][gostdlibpkgtexttemplate]. `index`: - -> ...returns the result of indexing its first argument by the following arguments. Thus "index x 1 2 3" is, in Go syntax, `x[1][2][3]`. Each indexed item must be a map, slice, or array. - -**Example 3:** - - {{ if or (or (isset .Params "title") (isset .Params "caption")) (isset .Params "attr") }} - Stuff Here - {{ end }} - -Could be rewritten as - - {{ if isset .Params "caption" | or isset .Params "title" | or isset .Params "attr" }} - Stuff Here - {{ end }} - -### Internet Explorer conditional comments using Pipes - -By default, Go Templates remove HTML comments from output. This has the unfortunate side effect of removing Internet Explorer conditional comments. As a workaround, use something like this: - - {{ "<!--[if lt IE 9]>" | safeHTML }} - <script src="html5shiv.js"></script> - {{ "<![endif]-->" | safeHTML }} - -Alternatively, use the backtick (`` ` ``) to quote the IE conditional comments, avoiding the tedious task of escaping every double quotes (`"`) inside, as demonstrated in the [examples](http://golang.org/pkg/text/template/#hdr-Examples) in the Go text/template documentation, e.g.: - -``` -{{ `<!--[if lt IE 7]><html class="no-js lt-ie9 lt-ie8 lt-ie7"><![endif]-->` | safeHTML }} -``` - -## Context (a.k.a. the dot) - -The most easily overlooked concept to understand about Go templates is that `{{ . }}` -always refers to the current context. In the top level of your template, this -will be the data set made available to it. Inside of a iteration, however, it will have -the value of the current item. When inside of a loop, the context has changed: -`{{ . }}` will no longer refer to the data available to the entire page. If you need -to -access this from within the loop, you will likely want to do one of the following: - -1. Set it to a variable instead of depending on the context. For example: - - {{ $title := .Site.Title }} - {{ range .Params.tags }} - <li> - <a href="{{ $baseURL }}/tags/{{ . | urlize }}">{{ . }}</a> - - {{ $title }} - </li> - {{ end }} - - Notice how once we have entered the loop the value of `{{ . }}` has changed. We - have defined a variable outside of the loop so we have access to it from within - the loop. - -2. Use `$.` to access the global context from anywhere. - Here is an equivalent example: - - {{ range .Params.tags }} - <li> - <a href="{{ $baseURL }}/tags/{{ . | urlize }}">{{ . }}</a> - - {{ $.Site.Title }} - </li> - {{ end }} - - This is because `$`, a special variable, is set to the starting value - of `.` the dot by default, - a [documented feature](http://golang.org/pkg/text/template/#hdr-Variables) - of Go text/template. Very handy, eh? - - > However, this little magic would cease to work if someone were to - > mischievously redefine `$`, e.g. `{{ $ := .Site }}`. - > *(No, don't do it!)* - > You may, of course, recover from this mischief by using `{{ $ := . }}` - > in a global context to reset `$` to its default value. - -## Whitespace - -Go 1.6 includes the ability to trim the whitespace from either side of a Go tag by including a hyphen (`-`) and space immediately beside the corresponding `{{` or `}}` delimiter. - -For instance, the following Go template: - -```html -<div> - {{ .Title }} -</div> -``` - -will include the newlines and horizontal tab in its HTML output: - -```html -<div> - Hello, World! -</div> -``` - -whereas using - -```html -<div> - {{- .Title -}} -</div> -``` - -in that case will output simply `<div>Hello, World!</div>`. - -Go considers the following characters as whitespace: space, horizontal tab, carriage return and newline. - -# Hugo Parameters - -Hugo provides the option of passing values to the template language -through the site configuration (for sitewide values), or through the meta -data of each specific piece of content. You can define any values of any -type (supported by your front matter/config format) and use them however -you want to inside of your templates. - - -## Using Content (page) Parameters - -In each piece of content, you can provide variables to be used by the -templates. This happens in the [front matter](/content/front-matter/). - -An example of this is used in this documentation site. Most of the pages -benefit from having the table of contents provided. Sometimes the TOC just -doesn't make a lot of sense. We've defined a variable in our front matter -of some pages to turn off the TOC from being displayed. - -Here is the example front matter: - -``` ---- -title: "Permalinks" -lastmod: 2015-11-30 -date: "2013-11-18" -aliases: - - "/doc/permalinks/" -groups: ["extras"] -groups_weight: 30 -notoc: true ---- -``` - -Here is the corresponding code inside of the template: - - {{ if not .Params.notoc }} - <div id="toc" class="well col-md-4 col-sm-6"> - {{ .TableOfContents }} - </div> - {{ end }} - - - -## Using Site (config) Parameters -In your top-level configuration file (e.g., `config.yaml`) you can define site -parameters, which are values which will be available to you in partials. - -For instance, you might declare: - -```yaml -params: - CopyrightHTML: "Copyright © 2013 John Doe. All Rights Reserved." - TwitterUser: "spf13" - SidebarRecentLimit: 5 -``` - -Within a footer layout, you might then declare a `<footer>` which is only -provided if the `CopyrightHTML` parameter is provided, and if it is given, -you would declare it to be HTML-safe, so that the HTML entity is not escaped -again. This would let you easily update just your top-level config file each -January 1st, instead of hunting through your templates. - -``` -{{if .Site.Params.CopyrightHTML}}<footer> -<div class="text-center">{{.Site.Params.CopyrightHTML | safeHTML}}</div> -</footer>{{end}} -``` - -An alternative way of writing the "`if`" and then referencing the same value -is to use "`with`" instead. With rebinds the context `.` within its scope, -and skips the block if the variable is absent: - -``` -{{with .Site.Params.TwitterUser}}<span class="twitter"> -<a href="https://twitter.com/{{.}}" rel="author"> -<img src="/images/twitter.png" width="48" height="48" title="Twitter: {{.}}" - alt="Twitter"></a> -</span>{{end}} -``` - -Finally, if you want to pull "magic constants" out of your layouts, you can do -so, such as in this example: - -``` -<nav class="recent"> - <h1>Recent Posts</h1> - <ul>{{range first .Site.Params.SidebarRecentLimit .Site.Pages}} - <li><a href="{{.RelPermalink}}">{{.Title}}</a></li> - {{end}}</ul> -</nav> -``` - -# Template example: Show only upcoming events - -Go allows you to do more than what's shown here. Using Hugo's -[`where`](/templates/functions/#where) function and Go built-ins, we can list -only the items from `content/events/` whose date (set in the front matter) is in -the future: - - <h4>Upcoming Events</h4> - <ul class="upcoming-events"> - {{ range where .Data.Pages.ByDate "Section" "events" }} - {{ if ge .Date.Unix .Now.Unix }} - <li><span class="event-type">{{ .Type | title }} —</span> - {{ .Title }} - on <span class="event-date"> - {{ .Date.Format "2 January at 3:04pm" }}</span> - at {{ .Params.place }} - </li> - {{ end }} - {{ end }} - -[go]: http://golang.org/ -[gohtmltemplate]: http://golang.org/pkg/html/template/ -[gostdlibpkgtexttemplate]: http://golang.org/pkg/text/template/ diff --git a/docs/content/templates/homepage.md b/docs/content/templates/homepage.md deleted file mode 100644 index c5cebd219..000000000 --- a/docs/content/templates/homepage.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -aliases: -- /layout/homepage/ -lastmod: 2015-08-04 -date: 2013-07-01 -menu: - main: - parent: layout -next: /templates/terms -notoc: true -prev: /templates/list -title: Homepage -weight: 50 ---- - -The home page of a website is often formatted differently than the other -pages. In Hugo you can define your own homepage template. - -Homepage is a `Page` and have all the [page -variables](/templates/variables/) and [site -variables](/templates/variables/) available to use in the templates. - -*This is the only required template for building a site and useful when -bootstrapping a new site and template. It is also the only required -template when using a single page site.* - -In addition to the standard page variables, the homepage has access to -all site content accessible from `.Data.Pages`. Details on how to use the -list of pages can be found in the [Lists Template](/templates/list/). - -Note that a home page can also have a content file with frontmatter, see [Source Organization]({{< relref "overview/source-directory.md#content-for-home-page-and-other-list-pages" >}}). - -## Which Template will be rendered? -Hugo uses a set of rules to figure out which template to use when -rendering a specific page. - -Hugo will use the following prioritized list. If a file isn’t present, -then the next one in the list will be used. This enables you to craft -specific layouts when you want to without creating more templates -than necessary. For most sites, only the \_default file at the end of -the list will be needed. - -* /layouts/index.html -* /layouts/\_default/list.html -* /layouts/\_default/single.html -* /themes/`THEME`/layouts/index.html -* /themes/`THEME`/layouts/\_default/list.html -* /themes/`THEME`/layouts/\_default/single.html - -## Example index.html -This content template is used for [spf13.com](http://spf13.com/). - -It makes use of [partial templates](/templates/partials/) and uses a similar approach as a [List](/templates/list/). - - <!DOCTYPE html> - <html class="no-js" lang="en-US" prefix="og: http://ogp.me/ns# fb: http://ogp.me/ns/fb#"> - <head> - <meta charset="utf-8"> - - {{ partial "meta.html" . }} - - <base href="{{ .Site.BaseURL }}"> - <title>{{ .Site.Title }}</title> - <link rel="canonical" href="{{ .Permalink }}"> - <link href="{{ .RSSLink }}" rel="alternate" type="application/rss+xml" title="{{ .Site.Title }}" /> - - {{ partial "head_includes.html" . }} - </head> - <body lang="en"> - - {{ partial "subheader.html" . }} - - <section id="main"> - <div> - {{ range first 10 .Data.Pages }} - {{ .Render "summary"}} - {{ end }} - </div> - </section> - - {{ partial "footer.html" . }} diff --git a/docs/content/templates/list.md b/docs/content/templates/list.md deleted file mode 100644 index 22d3123ac..000000000 --- a/docs/content/templates/list.md +++ /dev/null @@ -1,437 +0,0 @@ ---- -aliases: -- /layout/indexes/ -lastmod: 2015-08-04 -date: 2013-07-01 -linktitle: List of Content -menu: - main: - parent: layout -next: /templates/homepage -prev: /templates/content -title: Content List Template -weight: 40 -toc: true ---- - -A list template is any template that will be used to render multiple pieces of -content in a single HTML page (with the exception of the [homepage](/layout/homepage/) which has a -dedicated template). - -We are using the term list in its truest sense, a sequential arrangement -of material, especially in alphabetical or numerical order. Hugo uses -list templates to render anyplace where content is being listed such as -taxonomies and sections. - -## Which Template will be rendered? - -Hugo uses a set of rules to figure out which template to use when -rendering a specific page. - -Hugo will use the following prioritized list. If a file isn’t present, -then the next one in the list will be used. This enables you to craft -specific layouts when you want to without creating more templates -than necessary. For most sites only the \_default file at the end of -the list will be needed. - - -### Section Lists - -A Section will be rendered at /`SECTION`/ (e.g. http://spf13.com/project/) - -* /layouts/section/`SECTION`.html -* /layouts/`SECTION`/list.html -* /layouts/\_default/section.html -* /layouts/\_default/list.html -* /themes/`THEME`/layouts/section/`SECTION`.html -* /themes/`THEME`/layouts/`SECTION`/list.html -* /themes/`THEME`/layouts/\_default/section.html -* /themes/`THEME`/layouts/\_default/list.html - -Note that a sections list page can also have a content file with frontmatter, see [Source Organization]({{< relref "overview/source-directory.md#content-for-home-page-and-other-list-pages" >}}). - -### Taxonomy Lists - -A Taxonomy will be rendered at /`PLURAL`/`TERM`/ (e.g. http://spf13.com/topics/golang/) from: - -* /layouts/taxonomy/`SINGULAR`.html (e.g. `/layouts/taxonomy/topic.html`) -* /layouts/\_default/taxonomy.html -* /layouts/\_default/list.html -* /themes/`THEME`/layouts/taxonomy/`SINGULAR`.html -* /themes/`THEME`/layouts/\_default/taxonomy.html -* /themes/`THEME`/layouts/\_default/list.html - -Note that a taxonomy list page can also have a content file with frontmatter, see [Source Organization]({{< relref "overview/source-directory.md#content-for-home-page-and-other-list-pages" >}}). - -### Section RSS - -A Section’s RSS will be rendered at /`SECTION`/index.xml (e.g. http://spf13.com/project/index.xml) - -*Hugo ships with its own [RSS 2.0][] template. In most cases this will -be sufficient, and an RSS template will not need to be provided by the -user.* - -Hugo provides the ability for you to define any RSS type you wish, and -can have different RSS files for each section and taxonomy. - -* /layouts/section/`SECTION`.rss.xml -* /layouts/\_default/rss.xml -* /themes/`THEME`/layouts/section/`SECTION`.rss.xml -* /themes/`THEME`/layouts/\_default/rss.xml - -### Taxonomy RSS - -A Taxonomy’s RSS will be rendered at /`PLURAL`/`TERM`/index.xml (e.g. http://spf13.com/topics/golang/index.xml) - -*Hugo ships with its own [RSS 2.0][] template. In most cases this will -be sufficient, and an RSS template will not need to be provided by the -user.* - -Hugo provides the ability for you to define any RSS type you wish, and -can have different RSS files for each section and taxonomy. - -* /layouts/taxonomy/`SINGULAR`.rss.xml -* /layouts/\_default/rss.xml -* /themes/`THEME`/layouts/taxonomy/`SINGULAR`.rss.xml -* /themes/`THEME`/layouts/\_default/rss.xml - - -## Variables - -A list page is a `Page` and have all the [page variables](/templates/variables/) -and [site variables](/templates/variables/) available to use in the templates. - -Taxonomy pages will additionally have: - -**.Data.`Singular`** The taxonomy itself.<br> - -## Example List Template Pages - -### Example section template (post.html) -This content template is used for [spf13.com](http://spf13.com/). -It makes use of [partial templates](/templates/partials/). All examples use a -[view](/templates/views/) called either "li" or "summary" which this example site -defined. - - {{ partial "header.html" . }} - {{ partial "subheader.html" . }} - - <section id="main"> - <div> - <h1 id="title">{{ .Title }}</h1> - <ul id="list"> - {{ range .Data.Pages }} - {{ .Render "li"}} - {{ end }} - </ul> - </div> - </section> - - {{ partial "footer.html" . }} - -### Example taxonomy template (tag.html) -This content template is used for [spf13.com](http://spf13.com/). -It makes use of [partial templates](/templates/partials/). All examples use a -[view](/templates/views/) called either "li" or "summary" which this example site -defined. - - {{ partial "header.html" . }} - {{ partial "subheader.html" . }} - - <section id="main"> - <div> - <h1 id="title">{{ .Title }}</h1> - {{ range .Data.Pages }} - {{ .Render "summary"}} - {{ end }} - </div> - </section> - - {{ partial "footer.html" . }} - -## Ordering Content - -In the case of Hugo, each list will render the content based on metadata provided in the [front -matter](/content/front-matter/). See [ordering content](/content/ordering/) for more information. - -Here are a variety of different ways you can order the content items in -your list templates: - -### Order by Weight -> Date (default) - - {{ range .Data.Pages }} - <li> - <a href="{{ .Permalink }}">{{ .Title }}</a> - <div class="meta">{{ .Date.Format "Mon, Jan 2, 2006" }}</div> - </li> - {{ end }} - -### Order by Weight -> Date - - {{ range .Data.Pages.ByWeight }} - <li> - <a href="{{ .Permalink }}">{{ .Title }}</a> - <div class="meta">{{ .Date.Format "Mon, Jan 2, 2006" }}</div> - </li> - {{ end }} - -### Order by Date - - {{ range .Data.Pages.ByDate }} - <li> - <a href="{{ .Permalink }}">{{ .Title }}</a> - <div class="meta">{{ .Date.Format "Mon, Jan 2, 2006" }}</div> - </li> - {{ end }} - -### Order by PublishDate - - {{ range .Data.Pages.ByPublishDate }} - <li> - <a href="{{ .Permalink }}">{{ .Title }}</a> - <div class="meta">{{ .PublishDate.Format "Mon, Jan 2, 2006" }}</div> - </li> - {{ end }} - -### Order by ExpiryDate - - {{ range .Data.Pages.ByExpiryDate }} - <li> - <a href="{{ .Permalink }}">{{ .Title }}</a> - <div class="meta">{{ .ExpiryDate.Format "Mon, Jan 2, 2006" }}</div> - </li> - {{ end }} - -### Order by Lastmod - - {{ range .Data.Pages.ByLastmod }} - <li> - <a href="{{ .Permalink }}">{{ .Title }}</a> - <div class="meta">{{ .Date.Format "Mon, Jan 2, 2006" }}</div> - </li> - {{ end }} - -### Order by Length - - {{ range .Data.Pages.ByLength }} - <li> - <a href="{{ .Permalink }}">{{ .Title }}</a> - <div class="meta">{{ .Date.Format "Mon, Jan 2, 2006" }}</div> - </li> - {{ end }} - - -### Order by Title - - {{ range .Data.Pages.ByTitle }} - <li> - <a href="{{ .Permalink }}">{{ .Title }}</a> - <div class="meta">{{ .Date.Format "Mon, Jan 2, 2006" }}</div> - </li> - {{ end }} - -### Order by LinkTitle - - {{ range .Data.Pages.ByLinkTitle }} - <li> - <a href="{{ .Permalink }}">{{ .LinkTitle }}</a> - <div class="meta">{{ .Date.Format "Mon, Jan 2, 2006" }}</div> - </li> - {{ end }} - -### Order by Parameter - -Order based on the specified frontmatter parameter. Pages without that -parameter will use the site's `.Site.Params` default. If the parameter is not -found at all in some entries, those entries will appear together at the end -of the ordering. - -The below example sorts a list of posts by their rating. - - {{ range (.Data.Pages.ByParam "rating") }} - <!-- ... --> - {{ end }} - -If the frontmatter field of interest is nested beneath another field, you can -also get it: - - {{ range (.Data.Pages.ByParam "author.last_name") }} - <!-- ... --> - {{ end }} - -### Reverse Order -Can be applied to any of the above. Using Date for an example. - - {{ range .Data.Pages.ByDate.Reverse }} - <li> - <a href="{{ .Permalink }}">{{ .Title }}</a> - <div class="meta">{{ .Date.Format "Mon, Jan 2, 2006" }}</div> - </li> - {{ end }} - -## Grouping Content - -Hugo provides some grouping functions for list pages. You can use them to -group pages by Section, Type, Date etc. - -Here are a variety of different ways you can group the content items in -your list templates: - -### Grouping by Page field - - {{ range .Data.Pages.GroupBy "Section" }} - <h3>{{ .Key }}</h3> - <ul> - {{ range .Pages }} - <li> - <a href="{{ .Permalink }}">{{ .Title }}</a> - <div class="meta">{{ .Date.Format "Mon, Jan 2, 2006" }}</div> - </li> - {{ end }} - </ul> - {{ end }} - -### Grouping by Page date - - {{ range .Data.Pages.GroupByDate "2006-01" }} - <h3>{{ .Key }}</h3> - <ul> - {{ range .Pages }} - <li> - <a href="{{ .Permalink }}">{{ .Title }}</a> - <div class="meta">{{ .Date.Format "Mon, Jan 2, 2006" }}</div> - </li> - {{ end }} - </ul> - {{ end }} - -### Grouping by Page publish date - - {{ range .Data.Pages.GroupByPublishDate "2006-01" }} - <h3>{{ .Key }}</h3> - <ul> - {{ range .Pages }} - <li> - <a href="{{ .Permalink }}">{{ .Title }}</a> - <div class="meta">{{ .PublishDate.Format "Mon, Jan 2, 2006" }}</div> - </li> - {{ end }} - </ul> - {{ end }} - -### Grouping by Page param - - {{ range .Data.Pages.GroupByParam "param_key" }} - <h3>{{ .Key }}</h3> - <ul> - {{ range .Pages }} - <li> - <a href="{{ .Permalink }}">{{ .Title }}</a> - <div class="meta">{{ .Date.Format "Mon, Jan 2, 2006" }}</div> - </li> - {{ end }} - </ul> - {{ end }} - -### Grouping by Page param in date format - - {{ range .Data.Pages.GroupByParamDate "param_key" "2006-01" }} - <h3>{{ .Key }}</h3> - <ul> - {{ range .Pages }} - <li> - <a href="{{ .Permalink }}">{{ .Title }}</a> - <div class="meta">{{ .Date.Format "Mon, Jan 2, 2006" }}</div> - </li> - {{ end }} - </ul> - {{ end }} - -### Reversing Key Order - -The ordering of the groups is performed by keys in alphanumeric order (A–Z, -1–100) and in reverse chronological order (newest first) for dates. - -While these are logical defaults, they are not always the desired order. There -are two different syntaxes to change the order; they both work the same way, so -it’s really just a matter of preference. - -#### Reverse method - - {{ range (.Data.Pages.GroupBy "Section").Reverse }} - ... - - {{ range (.Data.Pages.GroupByDate "2006-01").Reverse }} - ... - - -#### Providing the (alternate) direction - - {{ range .Data.Pages.GroupByDate "2006-01" "asc" }} - ... - - {{ range .Data.Pages.GroupBy "Section" "desc" }} - ... - -### Ordering Pages within Group - -Because Grouping returns a key and a slice of pages, all of the ordering methods listed above are available. - -In this example, I’ve ordered the groups in chronological order and the content -within each group in alphabetical order by title. - - {{ range .Data.Pages.GroupByDate "2006-01" "asc" }} - <h3>{{ .Key }}</h3> - <ul> - {{ range .Pages.ByTitle }} - <li> - <a href="{{ .Permalink }}">{{ .Title }}</a> - <div class="meta">{{ .Date.Format "Mon, Jan 2, 2006" }}</div> - </li> - {{ end }} - </ul> - {{ end }} - -## Filtering & Limiting Content - -Sometimes you only want to list a subset of the available content. A common -request is to only display “Posts” on the homepage. Using the `where` function, -you can do just that. - -### `first` - -`first` works like the `limit` keyword in SQL. It reduces the array to only the -first _N_ elements. It takes the array and number of elements as input. - - {{ range first 10 .Data.Pages }} - {{ .Render "summary" }} - {{ end }} - -### `where` - -`where` works in a similar manner to the `where` keyword in SQL. It selects all -elements of the slice that match the provided field and value. It takes three -arguments: 'array or slice of maps or structs', 'key or field name' and 'match -value'. - - {{ range where .Data.Pages "Section" "post" }} - {{ .Content }} - {{ end }} - -### `first` & `where` Together - -Using both together can be very powerful. - - {{ range first 5 (where .Data.Pages "Section" "post") }} - {{ .Content }} - {{ end }} - -If `where` or `first` receives invalid input or a field name that doesn’t exist, -it will return an error and stop site generation. - -These are both template functions and work on not only -[lists](/templates/list/), but [taxonomies](/taxonomies/displaying/), -[terms](/templates/terms/) and [groups](/templates/list/). - - -[RSS 2.0]: http://cyber.law.harvard.edu/rss/rss.html "RSS 2.0 Specification" diff --git a/docs/content/templates/overview.md b/docs/content/templates/overview.md deleted file mode 100644 index 3b41a6641..000000000 --- a/docs/content/templates/overview.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -aliases: -- /doc/templates/ -- /layout/templates/ -- /layout/overview/ -lastmod: 2015-05-22 -date: 2013-07-01 -linktitle: Overview -menu: - main: - parent: layout -next: /templates/go-templates -prev: /themes/creation -title: Hugo Templates -weight: 10 -toc: true ---- - -Hugo uses the excellent Go html/template library for its template engine. -It is an extremely lightweight engine that provides a very small amount of -logic. In our experience it is just the right amount of logic to be able -to create a good static website. - -While Hugo has a number of different template roles, most complete -websites can be built using just a small number of template files. -Please don’t be afraid of the variety of different template roles. They -enable Hugo to build very complicated sites. Most sites will only -need to create a [/layouts/\_default/single.html](/templates/content/) & [/layouts/\_default/list.html](/templates/list/) - -If you are new to Go's templates, the [Go Template Primer](/layout/go-templates/) -is a great place to start. - -If you are familiar with Go’s templates, Hugo provides some [additional -template functions](/templates/functions/) and [variables](/templates/variables/) you will want to be familiar -with. - -## Primary Template roles - -There are 3 primary kinds of templates that Hugo works with. - -### [Single](/templates/content/) -Render a single piece of content - -### [List](/templates/list/) -Page that list multiple pieces of content - -### [Homepage](/templates/homepage/) -The homepage of your site - -## Supporting Template Roles (optional) - -Hugo also has additional kinds of templates all of which are optional - -### [Partial Templates](/templates/partials/) -Common page parts to be included in the above mentioned templates - -### [Content Views](/templates/views/) -Different ways of rendering a (single) content type - -### [Taxonomy Terms](/templates/terms/) -A list of the terms used for a specific taxonomy, e.g. a Tag cloud - -## Other Templates (generally unnecessary) - -### [RSS](/templates/rss/) -Used to render all rss documents - -### [Sitemap](/templates/sitemap/) -Used to render the XML sitemap - -### [404](/templates/404/) -This template will create a 404.html page used when hosting on GitHub Pages - -### [Alias](/extras/aliases/#customizing) -This template will override the default page used to create aliases of pages. - diff --git a/docs/content/templates/partials.md b/docs/content/templates/partials.md deleted file mode 100644 index 46c2c2400..000000000 --- a/docs/content/templates/partials.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -aliases: -- /layout/chrome/ -lastmod: 2016-01-01 -date: 2013-07-01 -menu: - main: - parent: layout -next: /templates/rss -prev: /templates/blocks/ -title: Partial Templates -weight: 80 -toc: true ---- - -In practice, it's very convenient to split out common template portions into a -partial template that can be included anywhere. As you create the rest of your -templates, you will include templates from the ``/layouts/partials` directory -or from arbitrary subdirectories like `/layouts/partials/post/tag`. - -Partials are especially important for themes as it gives users an opportunity -to overwrite just a small part of your theme, while maintaining future compatibility. - -Theme developers may want to include a few partials with empty HTML -files in the theme just so end users have an easy place to inject their -customized content. - -I've found it helpful to include a header and footer template in -partials so I can include those in all the full page layouts. There is -nothing special about header.html and footer.html other than they seem -like good names to use for inclusion in your other templates. - - ▾ layouts/ - ▾ partials/ - header.html - footer.html - -## Partial vs Template - -Version v0.12 of Hugo introduced the `partial` call inside the template system. -This is a change to the way partials were handled previously inside the -template system. In earlier versions, Hugo didn’t treat partials specially, and -you could include a partial template with the `template` call in the standard -template language. - -With the addition of the theme system in v0.11, it became apparent that a theme -& override-aware partial was needed. - -When using Hugo v0.12 and above, please use the `partial` call (and leave out -the “partial/” path). The old approach would still work, but wouldn’t benefit from -the ability to have users override the partial theme file with local layouts. - -## Example header.html -This header template is used for [spf13.com](http://spf13.com/): - - <!DOCTYPE html> - <html class="no-js" lang="en-US" prefix="og: http://ogp.me/ns# fb: http://ogp.me/ns/fb#"> - <head> - <meta charset="utf-8"> - - {{ partial "meta.html" . }} - - <base href="{{ .Site.BaseURL }}"> - <title> {{ .Title }} : spf13.com </title> - <link rel="canonical" href="{{ .Permalink }}"> - {{ if .RSSLink }}<link href="{{ .RSSLink }}" rel="alternate" type="application/rss+xml" title="{{ .Title }}" />{{ end }} - - {{ partial "head_includes.html" . }} - </head> - <body lang="en"> - -## Example footer.html -This footer template is used for [spf13.com](http://spf13.com/): - - <footer> - <div> - <p> - © 2013-14 Steve Francia. - <a href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons Attribution">Some rights reserved</a>; - please attribute properly and link back. Hosted by <a href="http://servergrove.com">ServerGrove</a>. - </p> - </div> - </footer> - <script type="text/javascript"> - - var _gaq = _gaq || []; - _gaq.push(['_setAccount', 'UA-XYSYXYSY-X']); - _gaq.push(['_trackPageview']); - - (function() { - var ga = document.createElement('script'); - ga.src = ('https:' == document.location.protocol ? 'https://ssl' : - 'http://www') + '.google-analytics.com/ga.js'; - ga.setAttribute('async', 'true'); - document.documentElement.firstChild.appendChild(ga); - })(); - - </script> - </body> - </html> - -To reference a partial template stored in a subfolder, e.g. `/layouts/partials/post/tag/list.html`, call it this way: - - {{ partial "post/tag/list" . }} - -Note that the subdirectories you create under /layouts/partials can be named whatever you like. - -For more examples of referencing these templates, see -[single content templates](/templates/content/), -[list templates](/templates/list/) and -[homepage templates](/templates/homepage/). - - -## Variable scoping - -As you might have noticed, `partial` calls receive two parameters. - -1. The first is the name of the partial and determines the file -location to be read. -2. The second is the variables to be passed down to the partial. - -This means that the partial will _only_ be able to access those variables. It is -isolated and has no access to the outer scope. From within the -partial, `$.Var` is equivalent to `.Var` - -## Cached Partials - -The `partialCached` template function can offer significant performance gains -for complex templates that don't need to be rerendered upon every invocation. -The simplest usage is as follows: - - {{ partialCached "footer.html" . }} - -You can also pass additional parameters to `partialCached` to create *variants* of the cached partial. -For example, say you have a complex partial that should be identical when rendered for pages within the same section. -You could use a variant based upon section so that the partial is only rendered once per section: - - {{ partialCached "footer.html" . .Section }} - -If you need to pass additional parameters to create unique variants, -you can pass as many variant parameters as you need: - - {{ partialCached "footer.html" . .Params.country .Params.province }} - -Note that the variant parameters are not made available to the underlying partial template. -They are only use to create a unique cache key. diff --git a/docs/content/templates/rss.md b/docs/content/templates/rss.md deleted file mode 100644 index d14b574b4..000000000 --- a/docs/content/templates/rss.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -aliases: -- /layout/rss/ -lastmod: 2015-08-04 -date: 2015-05-19 -linktitle: RSS -menu: - main: - parent: layout -next: /templates/sitemap -notoc: one -prev: /templates/partials -title: RSS (feed) Templates -weight: 90 -toc: true ---- - -Like all other templates, you can use a single RSS template to generate all of your RSS feeds, or you can create a specific template for each individual feed. - -*Unlike other Hugo templates*, Hugo ships with its own [RSS 2.0 template](#the-embedded-rss-xml:eceb479b7b3b2077408a2878a29e1320). In most cases this will be sufficient, and an RSS template will not need to be provided by the user. But you can provide an rss template if you like, as you can see in the next section. - -RSS pages are of the type `Page` and have all the [page variables](/layout/variables/) available to use in the templates. - -## Which Template will be rendered? -Hugo uses a set of rules to figure out which template to use when rendering a specific page. - -Hugo will use the following prioritized list. If a file isn’t present, then the next one in the list will be used. This enables you to craft specific layouts when you want to without creating more templates than necessary. For most sites only the `\_default` file at the end of the list will be needed. - -### Main RSS - -* /layouts/rss.xml -* /layouts/\_default/rss.xml -* [Embedded rss.xml](#the-embedded-rss-xml:eceb479b7b3b2077408a2878a29e1320) - -### Section RSS - -* /layouts/section/`SECTION`.rss.xml -* /layouts/\_default/rss.xml -* /themes/`THEME`/layouts/section/`SECTION`.rss.xml -* /themes/`THEME`/layouts/\_default/rss.xml -* [Embedded rss.xml](#the-embedded-rss-xml:eceb479b7b3b2077408a2878a29e1320) - -### Taxonomy RSS - -* /layouts/taxonomy/`SINGULAR`.rss.xml -* /layouts/\_default/rss.xml -* /themes/`THEME`/layouts/taxonomy/`SINGULAR`.rss.xml -* /themes/`THEME`/layouts/\_default/rss.xml -* [Embedded rss.xml](#the-embedded-rss-xml:eceb479b7b3b2077408a2878a29e1320) - -### Taxonomy Terms RSS - -* /layouts/taxonomy/`SINGULAR`.terms.rss.xml -* /layouts/\_default/rss.xml -* /themes/`THEME`/layouts/taxonomy/`SINGULAR`.terms.rss.xml -* /themes/`THEME`/layouts/\_default/rss.xml -* [Embedded rss.xml](#the-embedded-rss-xml:eceb479b7b3b2077408a2878a29e1320) - - -## Configuring RSS - -If the following values are specified in the site’s config file (`config.toml`), then they will be included in the RSS output. Example values are provided. - - languageCode = "en-us" - copyright = "This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License." - - [author] - name = "My Name Here" - email = "sample@domain.tld" - -### Limiting the Number of Items - -By default, the RSS feed is limited to **15** items. -You may override the default by using the `rssLimit` [site configuration variable](/overview/configuration/). - -## The Embedded rss.xml -This is the default RSS template that ships with Hugo. It adheres to the [RSS 2.0 Specification][RSS 2.0]. - - <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"> - <channel> - <title>{{ if eq .Title .Site.Title }}{{ .Site.Title }}{{ else }}{{ with .Title }}{{.}} on {{ end }}{{ .Site.Title }}{{ end }}</title> - <link>{{ .Permalink }}</link> - <description>Recent content {{ if ne .Title .Site.Title }}{{ with .Title }}in {{.}} {{ end }}{{ end }}on {{ .Site.Title }}</description> - <generator>Hugo -- gohugo.io</generator>{{ with .Site.LanguageCode }} - <language>{{.}}</language>{{end}}{{ with .Site.Author.email }} - <managingEditor>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</managingEditor>{{end}}{{ with .Site.Author.email }} - <webMaster>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</webMaster>{{end}}{{ with .Site.Copyright }} - <copyright>{{.}}</copyright>{{end}}{{ if not .Date.IsZero }} - <lastBuildDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</lastBuildDate>{{ end }} - <atom:link href="{{.Permalink}}" rel="self" type="application/rss+xml" /> - {{ range .Data.Pages }} - <item> - <title>{{ .Title }}</title> - <link>{{ .Permalink }}</link> - <pubDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</pubDate> - {{ with .Site.Author.email }}<author>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</author>{{end}} - <guid>{{ .Permalink }}</guid> - <description>{{ .Content | html }}</description> - </item> - {{ end }} - </channel> - </rss> - -**Important**: _Hugo will automatically add the following header line to this file on render… please don't include this in the template as it's not valid HTML._ - -~~~css -<?xml version="1.0" encoding="utf-8" standalone="yes" ?> -~~~ - -## Referencing your RSS Feed in `<head>` - -In your `header.html` template, you can specify your RSS feed in your `<head></head>` tag like this: - -~~~html -{{ if .RSSLink }} - <link href="{{ .RSSLink }}" rel="alternate feed" type="application/rss+xml" title="{{ .Site.Title }}" /> -{{ end }} -~~~ - -... with the autodiscovery link specified by the line with `rel="alternate"`. - -The `.RSSLink` will render the appropriate RSS feed URL for the section, whether it's everything, posts in a section, or a taxonomy. - -**N.b.**, if you reference your RSS link, be sure to specify the mime type with `type="application/rss+xml"`. - -~~~html -<a href="{{ .URL }}" type="application/rss+xml" target="_blank">{{ .SomeText }}</a> -~~~ - -[RSS 2.0]: http://cyber.law.harvard.edu/rss/rss.html "RSS 2.0 Specification" diff --git a/docs/content/templates/sitemap.md b/docs/content/templates/sitemap.md deleted file mode 100644 index c893f3155..000000000 --- a/docs/content/templates/sitemap.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -aliases: -- /layout/sitemap/ -lastmod: 2015-12-10 -date: 2014-05-07 -linktitle: Sitemap -menu: - main: - parent: layout -next: /templates/404 -notoc: true -prev: /templates/rss -title: Sitemap Template -weight: 95 ---- - -A single Sitemap template is used to generate the `sitemap.xml` file. -Hugo automatically comes with this template file. **No work is needed on -the users' part unless they want to customize `sitemap.xml`.** - -A sitemap is a `Page` and have all the [page -variables](/layout/variables/) available to use in this template -along with Sitemap-specific ones: - -**.Sitemap.ChangeFreq** The page change frequency<br> -**.Sitemap.Priority** The priority of the page<br> -**.Sitemap.Filename** The sitemap filename<br> - -If provided, Hugo will use `/layouts/sitemap.xml` instead of the internal -one. - -## Hugo’s sitemap.xml - -This template uses the version 0.9 of the [Sitemap -Protocol](http://www.sitemaps.org/protocol.html) with Google's [hreflang -attributes](https://support.google.com/webmasters/answer/2620865?hl=en&topic=2370587&ctx=topic) -for linking to translated content. - - <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" - xmlns:xhtml="http://www.w3.org/1999/xhtml"> - {{ range .Data.Pages }} - <url> - <loc>{{ .Permalink }}</loc>{{ if not .Lastmod.IsZero }} - <lastmod>{{ safeHTML ( .Lastmod.Format "2006-01-02T15:04:05-07:00" ) }}</lastmod>{{ end }}{{ with .Sitemap.ChangeFreq }} - <changefreq>{{ . }}</changefreq>{{ end }}{{ if ge .Sitemap.Priority 0.0 }} - <priority>{{ .Sitemap.Priority }}</priority>{{ end }}{{ if .IsTranslated }}{{ range .Translations }} - <xhtml:link - rel="alternate" - hreflang="{{ .Lang }}" - href="{{ .Permalink }}" - />{{ end }} - <xhtml:link - rel="alternate" - hreflang="{{ .Lang }}" - href="{{ .Permalink }}" - />{{ end }} - </url> - {{ end }} - </urlset> - -***Important:** Hugo will automatically add the following header line to this file -on render. Please don't include this in the template as it's not valid HTML.* - - <?xml version="1.0" encoding="utf-8" standalone="yes" ?> - -## Configuring sitemap.xml - -Defaults for `<changefreq>`, `<priority>` and `filename` values can be set in the site's config file, e.g.: - - [sitemap] - changefreq = "monthly" - priority = 0.5 - filename = "sitemap.xml" - -The same fields can be specified in an individual page's front matter in order to override the value for that page. diff --git a/docs/content/templates/terms.md b/docs/content/templates/terms.md deleted file mode 100644 index 83414ceed..000000000 --- a/docs/content/templates/terms.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -aliases: -- /indexes/lists/ -- /doc/indexes/ -- /extras/indexes -lastmod: 2015-09-15 -date: 2014-05-21 -linktitle: Taxonomy Terms -menu: - main: - parent: layout -next: /templates/views -prev: /templates/homepage -title: Taxonomy Terms Template -weight: 60 -toc: true ---- - -A unique template is needed to create a list of the terms for a given -taxonomy. This is different from the [list template](/templates/list/) -as that template is a list of content, whereas this is a list of meta data. - -Note that a taxonomy terms page can also have a content file with frontmatter, see [Source Organization]({{< relref "overview/source-directory.md#content-for-home-page-and-other-list-pages" >}}). - -## Which Template will be rendered? -Hugo uses a set of rules to figure out which template to use when -rendering a specific page. - -A Taxonomy Terms List will be rendered at /`PLURAL`/ -(e.g. http://spf13.com/topics/) -from the following prioritized list: - -* /layouts/taxonomy/`SINGULAR`.terms.html (e.g. `/layouts/taxonomy/topic.terms.html`) -* /layouts/\_default/terms.html - -If a file isn’t present, -then the next one in the list will be used. This enables you to craft -specific layouts when you want to without creating more templates -than necessary. For most sites, only the `_default` file at the end of -the list will be needed. - -If that neither file is found in either the /layouts or /theme/layouts -directory, then Hugo will not render the taxonomy terms pages. It is also -common for people to render taxonomy terms lists on other pages such as -the homepage or the sidebar (such as a tag cloud) and not have a -dedicated page for the terms. - - -## Variables - -Taxonomy Terms pages are of the type `Page` and have all the -[page variables](/templates/variables/) and -[site variables](/templates/variables/) -available to use in the templates. - -Taxonomy Terms pages will additionally have: - -* **.Data.Singular** The singular name of the taxonomy -* **.Data.Plural** The plural name of the taxonomy -* **.Data.Pages** (or as **.Pages**) The taxonomy Terms index pages -* **.Data.Terms** The taxonomy itself -* **.Data.Terms.Alphabetical** The Terms alphabetized -* **.Data.Terms.ByCount** The Terms ordered by popularity - -The last two can also be reversed: **.Data.Terms.Alphabetical.Reverse**, **.Data.Terms.ByCount.Reverse**. - -### Example terms.html files - -This content template is used for [spf13.com](http://spf13.com/). -It makes use of [partial templates](/templates/partials/). The list of taxonomy -templates cannot use a [content view](/templates/views/) as they don't display the content, but -rather information about the content. - -This particular template lists all of the Tags used on -[spf13.com](http://spf13.com/) and provides a count for the number of pieces of -content tagged with each tag. - -`.Data.Terms` is a map of terms ⇒ [contents] - - {{ partial "header.html" . }} - {{ partial "subheader.html" . }} - - <section id="main"> - <div> - <h1 id="title">{{ .Title }}</h1> - - <ul> - {{ $data := .Data }} - {{ range $key, $value := .Data.Terms }} - <li><a href="{{ $.Site.LanguagePrefix }}/{{ $data.Plural }}/{{ $key | urlize }}">{{ $key }}</a> {{ len $value }}</li> - {{ end }} - </ul> - </div> - </section> - - {{ partial "footer.html" . }} - - -Another example listing the content for each term (ordered by Date): - - {{ partial "header.html" . }} - {{ partial "subheader.html" . }} - - <section id="main"> - <div> - <h1 id="title">{{ .Title }}</h1> - - {{ $data := .Data }} - {{ range $key,$value := .Data.Terms.ByCount }} - <h2><a href="{{ $.Site.LanguagePrefix }}/{{ $data.Plural }}/{{ $value.Name | urlize }}">{{ $value.Name }}</a> {{ $value.Count }}</h2> - <ul> - {{ range $value.Pages.ByDate }} - <li><a href="{{ .Permalink }}">{{ .Title }}</a></li> - {{ end }} - </ul> - {{ end }} - </div> - </section> - - {{ partial "footer.html" . }} - - -## Ordering - -Hugo can order the term meta data in two different ways. It can be ordered: - -* by the number of contents assigned to that key, or -* alphabetically. - -### Example terms.html file (alphabetical) - - {{ partial "header.html" . }} - {{ partial "subheader.html" . }} - - <section id="main"> - <div> - <h1 id="title">{{ .Title }}</h1> - <ul> - {{ $data := .Data }} - {{ range $key, $value := .Data.Terms.Alphabetical }} - <li><a href="{{ $.Site.LanguagePrefix }}/{{ $data.Plural }}/{{ $value.Name | urlize }}">{{ $value.Name }}</a> {{ $value.Count }}</li> - {{ end }} - </ul> - </div> - </section> - {{ partial "footer.html" . }} - -### Example terms.html file (ordered by popularity) - - {{ partial "header.html" . }} - {{ partial "subheader.html" . }} - - <section id="main"> - <div> - <h1 id="title">{{ .Title }}</h1> - <ul> - {{ $data := .Data }} - {{ range $key, $value := .Data.Terms.ByCount }} - <li><a href="{{ $.Site.LanguagePrefix }}/{{ $data.Plural }}/{{ $value.Name | urlize }}">{{ $value.Name }}</a> {{ $value.Count }}</li> - {{ end }} - </ul> - </div> - </section> - - {{ partial "footer.html" . }} - -Hugo can also order and paginate the term index pages in all the normal ways. - -### Example terms.html snippet (paginated and ordered by date) - - <h1 id="title">{{ .Title }}</h1> - <ul> - {{ range .Paginator.Pages.ByDate.Reverse }} - <li><a href="{{ .Permalink }}">{{ .Title }}</a> {{ $.Data.Terms.Count .Data.Term }}</li> - {{ end }} - </ul> diff --git a/docs/content/templates/variables.md b/docs/content/templates/variables.md deleted file mode 100644 index 962297156..000000000 --- a/docs/content/templates/variables.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -aliases: -- /doc/variables/ -- /layout/variables/ -lastmod: 2015-12-08 -date: 2013-07-01 -linktitle: Variables -menu: - main: - parent: layout -next: /templates/content -prev: /templates/functions -title: Template Variables -weight: 20 -toc: true ---- - -Hugo makes a set of values available to the templates. Go templates are context based. The following -are available in the context for the templates. - -## Page Variables - -The following is a list of most of the accessible variables which can be -defined for a piece of content. Many of these will be defined in the front -matter, content or derived from file location. - -**See also:** [Scratch](/extras/scratch) for page-scoped writable variables. - - - -**.Content** The content itself, defined below the front matter.<br> -**.Data** The data specific to this type of page.<br> -**.Date** The date the page is associated with.<br> -**.Description** The description for the page.<br> -**.Draft** A boolean, `true` if the content is marked as a draft in the front matter.<br> -**.ExpiryDate** The date where the content is scheduled to expire on.<br> -**.FuzzyWordCount** The approximate number of words in the content.<br> -**.Hugo** See [Hugo Variables]({{< relref "#hugo-variables" >}}) below.<br> -**.IsHome** True if this is the home page.<br> -**.IsNode** Always false for regular content pages.<br> -**.IsPage** Always true for regular content pages.<br> -**.IsTranslated** Whether there are any translations to display.<br> -**.Keywords** The meta keywords for this content.<br> -**.Kind** What *kind* of page is this: is one of *page, home, section, taxonomy or taxonomyTerm.* There are also *RSS, sitemap, robotsTXT and 404*, but these will only available during rendering of that kind of page, and not available in any of the `Pages` collections.<br> -**.Lang** Language taken from the language extension notation.<br> -**.Language** A language object that points to this the language's definition in the site config.<br> -**.Lastmod** The date the content was last modified.<br> -**.LinkTitle** Access when creating links to this content. Will use `linktitle` if set in front matter, else `title`.<br> -**.Next** Pointer to the following content (based on pub date).<br> -**.NextInSection** Pointer to the following content within the same section (based on pub date)<br> -**.Pages** a collection of associated pages. This will be nil for regular content pages. This is an alias for **.Data.Pages**.<br> -**.Permalink** The Permanent link for this page.<br> -**.Prev** Pointer to the previous content (based on pub date).<br> -**.PrevInSection** Pointer to the previous content within the same section (based on pub date). For example, `{{if .PrevInSection}}{{.PrevInSection.Permalink}}{{end}}`.<br> -**.PublishDate** The date the content is published on.<br> -**.RSSLink** Link to the taxonomies' RSS link.<br> -**.RawContent** Raw Markdown content without the metadata header. Useful with [remarkjs.com](http://remarkjs.com)<br> -**.ReadingTime** The estimated time it takes to read the content in minutes.<br> -**.Ref** Returns the permalink for a given reference. Example: `.Ref "sample.md"`. See [cross-references]({{% ref "extras/crossreferences.md" %}}). Does not handle in-page fragments correctly.<br> -**.RelPermalink** The Relative permanent link for this page.<br> -**.RelRef** Returns the relative permalink for a given reference. Example: `RelRef "sample.md"`. See [cross-references]({{% ref "extras/crossreferences.md" %}}). Does not handle in-page fragments.<br> -**.Section** The [section](/content/sections/) this content belongs to.<br> -**.Site** See [Site Variables]({{< relref "#site-variables" >}}) below.<br> -**.Summary** A generated summary of the content for easily showing a snippet in a summary view. Note that the breakpoint can be set manually by inserting <code><!--more--></code> at the appropriate place in the content page. See [Summaries](/content/summaries/) for more details.<br> -**.TableOfContents** The rendered table of contents for this content.<br> -**.Title** The title for this page.<br> -**.Translations** A list of translated versions of the current page. See [Multilingual]({{< relref "content/multilingual.md" >}}) for more info.<br> -**.Truncated** A boolean, `true` if the `.Summary` is truncated. Useful for showing a "Read more..." link only if necessary. See [Summaries](/content/summaries/) for more details.<br> -**.Type** The content [type](/content/types/) (e.g. post).<br> -**.URL** The relative URL for this page. Note that if `URL` is set directly in frontmatter, that URL is returned as-is.<br> -**.UniqueID** The MD5-checksum of the content file's path<br> -**.Weight** Assigned weight (in the front matter) to this content, used in sorting.<br> -**.WordCount** The number of words in the content.<br> - -## Page Params - -Any other value defined in the front matter, including taxonomies, will be made available under `.Params`. -For example, the *tags* and *categories* taxonomies are accessed with: - -* **.Params.tags** -* **.Params.categories** - -**All Params are only accessible using all lowercase characters.** - -This is particularly useful for the introduction of user defined fields in content files. For example, a Hugo website on book reviews could have in the front matter of <code>/content/review/book01.md</code> - - --- - ... - affiliatelink: "http://www.my-book-link.here" - recommendedby: "my Mother" - --- - -Which would then be accessible to a template at `/themes/yourtheme/layouts/review/single.html` through `.Params.affiliatelink` and `.Params.recommendedby`, respectively. Two common situations where these could be introduced are as a value of a certain attribute (like `href=""` below) or by itself to be displayed. Sample syntaxes include: - - <h3><a href={{ printf "%s" $.Params.affiliatelink }}>Buy this book</a></h3> - <p>It was recommended by {{ .Params.recommendedby }}.</p> - -which would render - - <h3><a href="http://www.my-book-link.here">Buy this book</a></h3> - <p>It was recommended by my Mother.</p> - -**See also:** [Archetypes]({{% ref "content/archetypes.md" %}}) for consistency of `Params` across pieces of content. - -### Param method - -In Hugo you can declare params both for the site and the individual page. A -common use case is to have a general value for the site and a more specific -value for some of the pages (i.e. a header image): - -``` -{{ $.Param "header_image" }} -``` - -The `.Param` method provides a way to resolve a single value whether it's -in a page parameter or a site parameter. - -When frontmatter contains nested fields, like: - -``` ---- -author: - given_name: John - family_name: Feminella - display_name: John Feminella ---- -``` - -then `.Param` can access them by concatenating the field names together with a -dot: - -``` -{{ $.Param "author.display_name" }} -``` - -If your frontmatter contains a top-level key that is ambiguous with a nested -key, as in the following case, - -``` ---- -favorites.flavor: vanilla -favorites: - flavor: chocolate ---- -``` - -then the top-level key will be preferred. In the previous example, this - -``` -{{ $.Param "favorites.flavor" }} -``` - -will print `vanilla`, not `chocolate`. - -### Taxonomy Terms Page Variables - -[Taxonomy Terms](/templates/terms/) pages are of the type `Page` and have the following additional variables. These are available in `layouts/_defaults/terms.html` for example. - -**.Data.Singular** The singular name of the taxonomy<br> -**.Data.Plural** The plural name of the taxonomy<br> -**.Data.Pages** the list of pages in this taxonomy<br> -**.Data.Terms** The taxonomy itself<br> -**.Data.Terms.Alphabetical** The Terms alphabetized<br> -**.Data.Terms.ByCount** The Terms ordered by popularity<br> - -The last two can also be reversed: **.Data.Terms.Alphabetical.Reverse**, **.Data.Terms.ByCount.Reverse**. - -### Taxonomies elsewhere - -The **.Site.Taxonomies** variable holds all taxonomies defines site-wide. It is a map of the taxonomy name to a list of its values. For example: "tags" -> ["tag1", "tag2", "tag3"]. Each value, though, is not a string but rather a [Taxonomy variable](#the-taxonomy-variable). - -#### The Taxonomy variable - -The Taxonomy variable, available as **.Site.Taxonomies.tags** for example, contains the list of tags (values) and, for each of those, their corresponding content pages. - -## Site Variables - -Also available is `.Site` which has the following: - -**.Site.BaseURL** The base URL for the site as defined in the site configuration file.<br> -**.Site.RSSLink** The URL for the site RSS.<br> -**.Site.Taxonomies** The [taxonomies](/taxonomies/usage/) for the entire site. Replaces the now-obsolete `.Site.Indexes` since v0.11. Also see section [Taxonomies elsewhere](#taxonomies-elsewhere).<br> -**.Site.Pages** Array of all content ordered by Date, newest first. `.Site.Pages` replaced `.Site.Recent`, which is no longer supported. This array contains only the pages in the current language.<br> -**.Site.AllPages** Array of all pages regardless of their translation.<br> -**.Site.Params** A container holding the values from the `params` section of your site configuration file. For example, a TOML config file might look like this: - - baseURL = "http://yoursite.example.com/" - - [params] - description = "Tesla's Awesome Hugo Site" - author = "Nikola Tesla" -**.Site.Sections** Top level directories of the site.<br> -**.Site.Files** All of the source files of the site.<br> -**.Site.Menus** All of the menus in the site.<br> -**.Site.Title** A string representing the title of the site.<br> -**.Site.Author** A map of the authors as defined in the site configuration.<br> -**.Site.LanguageCode** A string representing the language as defined in the site configuration. This is mostly used to populate the RSS feeds with the right language code.<br> -**.Site.DisqusShortname** A string representing the shortname of the Disqus shortcode as defined in the site configuration.<br> -**.Site.GoogleAnalytics** A string representing your tracking code for Google Analytics as defined in the site configuration.<br> -**.Site.Copyright** A string representing the copyright of your web site as defined in the site configuration.<br> -**.Site.LastChange** A string representing the date/time of the most recent change to your site, based on the [`date` variable]({{< ref "content/front-matter.md#required-variables" >}}) in the front matter of your content pages.<br> -**.Site.Permalinks** A string to override the default permalink format. Defined in the site configuration.<br> -**.Site.BuildDrafts** A boolean (Default: false) to indicate whether to build drafts. Defined in the site configuration.<br> -**.Site.Data** Custom data, see [Data Files](/extras/datafiles/).<br> -**.Site.IsMultiLingual** Whether there are more than one language in this site.<br> See [Multilingual]({{< relref "content/multilingual.md" >}}) for more info.<br> -**.Site.Language** This indicates which language you are currently rendering the website for. This is an object with the attributes set in your language definition in your site config.<br> -**.Site.Language.Lang** The language code of the current locale, e.g. `en`.<br> -**.Site.Language.Weight** The weight that defines the order in the `.Site.Languages` list.<br> -**.Site.Language.LanguageName** The full language name, e.g. `English`.<br> -**.Site.LanguagePrefix** This can be used to prefix theURLs with whats needed to point to the correct language. It will even work when only one language defined. See also the functions [absLangURL and relLangURL]({{< relref "templates/functions.md#abslangurl-rellangurl" >}}).<br> -**.Site.Languages** An ordered list (ordered by defined weight) of languages.<br> -**.Site.RegularPages** A shortcut to the *regular page* collection. Equivalent to `where .Site.Pages "Kind" "page"`.<br> - -## File Variables - -The `.File` variable gives you additional information of a page. - -> **Note:** `.File` is only accessible on *Pages* that has a content page attached to it. - -Available are the following attributes: - -**.File.Path** The original relative path of the page, e.g. `content/posts/foo.en.md`<br> -**.File.LogicalName** The name of the content file that represents a page, e.g. `foo.en.md`<br> -**.File.TranslationBaseName** The filename without extension or optional language identifier, e.g. `foo`<br> -**.File.BaseFileName** The filename without extension, e.g. `foo.en`<br> -**.File.Ext** or **.File.Extension** The file extension of the content file, e.g. `md`<br> -**.File.Lang** The language associated with the given file if [Multilingual]({{< relref "content/multilingual.md" >}}) is enabled, e.g. `en`<br> -**.File.Dir** Given the path `content/posts/dir1/dir2/`, the relative directory path of the content file will be returned, e.g. `posts/dir1/dir2/`<br> - -## Hugo Variables - -Also available is `.Hugo` which has the following: - -**.Hugo.Generator** Meta tag for the version of Hugo that generated the site. Highly recommended to be included by default in all theme headers so we can start to track the usage and popularity of Hugo. Unlike other variables it outputs a **complete** HTML tag, e.g. `<meta name="generator" content="Hugo 0.15" />`<br> -**.Hugo.Version** The current version of the Hugo binary you are using e.g. `0.13-DEV`<br> -**.Hugo.CommitHash** The git commit hash of the current Hugo binary e.g. `0e8bed9ccffba0df554728b46c5bbf6d78ae5247`<br> -**.Hugo.BuildDate** The compile date of the current Hugo binary formatted with RFC 3339 e.g. `2002-10-02T10:00:00-05:00`<br> diff --git a/docs/content/templates/views.md b/docs/content/templates/views.md deleted file mode 100644 index c8426ec11..000000000 --- a/docs/content/templates/views.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -aliases: -- /templates/views/ -lastmod: 2015-05-22 -date: 2013-07-01 -menu: - main: - parent: layout -next: /templates/blocks -prev: /templates/terms -title: Content Views -weight: 70 -toc: true ---- - -In addition to the [single content template](/templates/content/), Hugo can render alternative views of -your content. These are especially useful in [list templates](/templates/list/). - -For example you may want content of every type to be shown on the -homepage, but only a summary view of it there. Perhaps on a taxonomy -list page you would only want a bulleted list of your content. Views -make this very straightforward by delegating the rendering of each -different type of content to the content itself. - - -## Creating a content view - -To create a new view, simply create a template in each of your different -content type directories with the view name. In the following example, we -have created a "li" view and a "summary" view for our two content types -of post and project. As you can see, these sit next to the [single -content view](/templates/content/) template "single.html". You can even -provide a specific view for a given type and continue to use the -\_default/single.html for the primary view. - - ▾ layouts/ - ▾ post/ - li.html - single.html - summary.html - ▾ project/ - li.html - single.html - summary.html - -Hugo also has support for a default content template to be used in the event -that a specific template has not been provided for that type. The default type -works the same as the other types, but the directory must be called "_default". -Content views can also be defined in the "_default" directory. - - - ▾ layouts/ - ▾ _default/ - li.html - single.html - summary.html - - -## Which Template will be rendered? -Hugo uses a set of rules to figure out which template to use when -rendering a specific page. - -Hugo will use the following prioritized list. If a file isn’t present, -then the next one in the list will be used. This enables you to craft -specific layouts when you want to without creating more templates -than necessary. For most sites only the \_default file at the end of -the list will be needed. - -* /layouts/`TYPE`/`VIEW`.html -* /layouts/\_default/`VIEW`.html -* /themes/`THEME`/layouts/`TYPE`/`VIEW`.html -* /themes/`THEME`/layouts/\_default/`view`.html - - -## Example using views - -### rendering view inside of a list - -Using the summary view (defined below) inside of a ([list -templates](/templates/list/)). - - <section id="main"> - <div> - <h1 id="title">{{ .Title }}</h1> - {{ range .Data.Pages }} - {{ .Render "summary"}} - {{ end }} - </div> - </section> - -In the above example, you will notice that we have called `.Render` and passed in -which view to render the content with. `.Render` is a special function available on -a content which tells the content to render itself with the provided view template. -In this example, we are not using the li view. To use this we would -change the render line to `{{ .Render "li" }}`. - - -### li.html - -Hugo will pass the entire page object to the view template. See [page -variables](/templates/variables/) for a complete list. - -This content template is used for [spf13.com](http://spf13.com/). - - <li> - <a href="{{ .Permalink }}">{{ .Title }}</a> - <div class="meta">{{ .Date.Format "Mon, Jan 2, 2006" }}</div> - </li> - -### summary.html - -Hugo will pass the entire page object to the view template. See [page -variables](/templates/variables/) for a complete list. - -This content template is used for [spf13.com](http://spf13.com/). - - <article class="post"> - <header> - <h2><a href='{{ .Permalink }}'> {{ .Title }}</a> </h2> - <div class="post-meta">{{ .Date.Format "Mon, Jan 2, 2006" }} - {{ .FuzzyWordCount }} Words </div> - </header> - - {{ .Summary }} - <footer> - <a href='{{ .Permalink }}'><nobr>Read more →</nobr></a> - </footer> - </article> - - diff --git a/docs/content/themes/creation.md b/docs/content/themes/creation.md deleted file mode 100644 index 5f7a2e53b..000000000 --- a/docs/content/themes/creation.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -lastmod: 2015-08-04 -date: 2014-05-12T10:09:17Z -menu: - main: - parent: themes -next: /templates/overview -prev: /themes/customizing -title: Creating a Theme -weight: 50 ---- - -Hugo has the ability to create a new theme in your themes directory for you -using the `hugo new` command. - -`hugo new theme [name]` - -This command will initialize all of the files and directories a basic theme -would need. Hugo themes are written in the Go template language. If you are new -to Go, the [Go template primer](/layout/go-templates/) will help you get started. - -## Theme Components - -A theme consists of templates and static assets such as javascript and css -files. Themes can also optionally provide [archetypes](/content/archetypes/) -which are archetypal content types used by the `hugo new` command. - -### Layouts - -Hugo is built around the concept that things should be as simple as possible. -Fundamentally website content is displayed in two different ways, a single -piece of content and a list of content items. With Hugo a theme layout starts -with the defaults. As additional layouts are defined they are used for the -content type or section they apply to. This keeps layouts simple, but permits -a large amount of flexibility. - -### Single Content - -The default single file layout is located at `layouts/_default/single.html`. - -### List of Contents - -The default list file layout is located at `layouts/_default/list.html`. - -### Partial Templates - -Theme creators should liberally use [partial templates](/templates/partials/) -throughout their theme files. Not only is a good DRY practice to include shared -code, but partials are a special template type that enables the themes end user -to be able to overwrite just a small piece of a file or inject code into the -theme from their local /layouts. These partial templates are perfect for easy -injection into the theme with minimal maintenance to ensure future -compatibility. - -### Static - -Everything in the static directory will be copied directly into the final site -when rendered. No structure is provided here to enable complete freedom. It is -common to organize the static content into: - - /css - /js - /img - -The actual structure is entirely up to you, the theme creator, on how you would like to organize your files. - - -### Archetypes - -If your theme makes use of specific keys in the front matter, it is a good idea -to provide an archetype for each content type you have. Archetypes follow the -[guidelines provided](/content/archetypes/). - - -### Generator meta tag - -With a growing community around Hugo we recommend theme creators to include the [Generator meta tag]({{< relref "templates/variables.md#hugo-variables" >}}) with `.Hugo.Generator` in the `<head>` of your HTML code. The output might looks like `<meta name="generator" content="Hugo 0.13" />` and helps us to analyse the usage and popularity of Hugo. - diff --git a/docs/content/themes/customizing.md b/docs/content/themes/customizing.md deleted file mode 100644 index f381106db..000000000 --- a/docs/content/themes/customizing.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -lastmod: 2015-08-04 -date: 2014-05-12T10:09:34Z -menu: - main: - parent: themes -next: /themes/creation -prev: /themes/usage -title: Customizing a Theme -weight: 40 -toc: true ---- - -_The following are key concepts for Hugo site customization. Hugo permits you to **supplement or override** any theme template or static file, with files in your working directory._ - -_When you use a theme cloned from its git repository, you do not edit the theme's files directly. Rather, you override them as per the following:_ - -## Replace Static Files - -For including a different file than what the theme ships with. For example, if you would like to use a more recent version of jQuery than what the theme happens to include, simply place an identically-named file in the same relative location but in your working directory. - -For example, if the theme has jQuery 1.6 in: - - /themes/themename/static/js/jquery.min.js - -... you would simply place your file in the same relative path, but in the root of your working folder: - - /static/js/jquery.min.js - -## Replace a single template file - -Anytime Hugo looks for a matching template, it will first check the working directory before looking in the theme directory. If you would like to modify a template, simply create that template in your local `layouts` directory. - -In the [template documentation](/templates/overview/) _each different template type explains the rules it uses to determine which template to use_. Read and understand these rules carefully. - -This is especially helpful when the theme creator used [partial templates](/templates/partials/). These partial templates are perfect for easy injection into the theme with minimal maintenance to ensure future compatibility. - -For example: - - /themes/themename/layouts/_default/single.html - -... would be overridden by: - - /layouts/_default/single.html - -**Warning**: This only works for templates that Hugo "knows about" (that follow its convention for folder structure and naming). If the theme imports template files in a creatively-named directory, Hugo won’t know to look for the local `/layouts` first. - -## Replace an archetype - -If the archetype that ships with the theme for a given content type (or all content types) doesn’t fit with how you are using the theme, feel free to copy it to your `/archetypes` directory and make modifications as you see fit. - -## Beware of the default - -**Default** is a very powerful force in Hugo, especially as it pertains to overwriting theme files. If a default is located in the local archetype directory or `/layouts/_default/` directory, it will be used instead of any of the similar files in the theme. - -It is usually better to override specific files rather than using the default in your working directory. diff --git a/docs/content/themes/installing.md b/docs/content/themes/installing.md deleted file mode 100644 index a70f50287..000000000 --- a/docs/content/themes/installing.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -lastmod: 2015-10-10 -date: 2014-05-12T10:09:49Z -menu: - main: - parent: themes -next: /themes/usage -prev: /themes/overview -title: Installing Themes -weight: 20 ---- - -Community-contributed [Hugo themes](http://themes.gohugo.io/), showcased -at [themes.gohugo.io](//themes.gohugo.io/), are hosted in a centralized -GitHub repository. The [Hugo Themes Repo](https://github.com/gohugoio/hugoThemes) -itself at [github.com/gohugoio/hugoThemes](https://github.com/gohugoio/hugoThemes) is -really a meta repository which contains pointers to set of contributed themes. - -## Installing all themes - -If you would like to install all of the available Hugo themes, simply -clone the entire repository from within your working directory. Depending -on your internet connection the download of all themes might take a while. - -> **NOTE:** Make sure you've installed [Git](https://git-scm.com/) on your computer. -Otherwise you will not be able to clone the theme repositories. - -```bash -$ git clone --depth 1 --recursive https://github.com/gohugoio/hugoThemes.git themes -``` -Before you use a theme, remove the .git folder in that theme's root folder. Otherwise, this will cause problem if you deploy using Git. - -## Installing a specific theme - -Switch into the `themes` directory and download a theme by replacing `URL_TO_THEME` -with the URL of the theme repository, e.g. `https://github.com/spf13/hyde`: - - $ cd themes - $ git clone URL_TO_THEME - -Alternatively, you can download the theme as `.zip` file and extract it in the -`themes` directory. - -**NOTE:** Please have a look at the `README.md` file that is shipped with all themes. -It might contain further instructions that are required to setup the theme, e.g. copying -an example configuration file. diff --git a/docs/content/themes/overview.md b/docs/content/themes/overview.md deleted file mode 100644 index 94e7259fd..000000000 --- a/docs/content/themes/overview.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -lastmod: 2015-10-10 -date: 2014-05-12T10:03:52Z -menu: - main: - parent: themes -next: /themes/installing -prev: /content/example -title: Themes Overview -weight: 10 ---- - -Hugo provides a robust theming system which is simple, yet capable of producing -even the most complicated websites. - -The Hugo community has created [a wide variety of beautiful themes](//themes.gohugo.io/), as demoed at [themes.gohugo.io](//themes.gohugo.io/), -ready for using in your own site. - -Hugo themes have been designed to be the perfect balance between -simplicity and functionality. Hugo themes are powered by the excellent -Go template library. If you are new to Go templates, see our [primer on -Go templates](/templates/go-templates/). - -Hugo themes support all modern features you come to expect. They are -structured in such a way to eliminate code duplication. Themes are also -designed to be very easy to customize while retaining the ability to -maintain upgradeability as the upstream theme changes. - -Hugo currently doesn’t ship with a “default” theme, allowing the user to -pick whichever theme best suits their project. - -We hope you will find Hugo themes perfect for your site. diff --git a/docs/content/themes/usage.md b/docs/content/themes/usage.md deleted file mode 100644 index 5b1d11c02..000000000 --- a/docs/content/themes/usage.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -lastmod: 2015-01-27 -date: 2014-05-12T10:09:27Z -menu: - main: - parent: themes -next: /themes/customizing -prev: /themes/installing -title: Using a Theme -weight: 30 ---- - -Please make certain you have installed the themes you want to use in the -`/themes` directory. - -To use a theme for a site, execute Hugo with the following parameter: - - hugo -t ThemeName - -or add this line to your site configuration: - - theme: "ThemeName" - -The *ThemeName* must match the name of the directory inside `/themes`. - -Hugo will then apply the theme first, then apply anything that is in the local -directory. To learn more, go to [customizing themes](/themes/customizing/). diff --git a/docs/content/tools/_index.md b/docs/content/tools/_index.md deleted file mode 100644 index d5543f045..000000000 --- a/docs/content/tools/_index.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -date: 2015-09-12T10:40:31+02:00 -title: Tools -weight: 120 ---- - -This section highlights some projects around Hugo that are independently developed. These tools try to extend the functionality of our static site generator or help you to get started. - -> **Note:** Do you know or maintain a similar project around Hugo? Feel free to open a [pull request](https://github.com/gohugoio/hugo/pulls) on GitHub if you think it should be added. - - -## Migration - -Take a look at this list of migration tools if you currently use other blogging tools like Jekyll or WordPress but intend to switch to Hugo instead. They'll take care to export -your content into Hugo-friendly formats. - -### Jekyll - -Alternatively, you can follow the manual [migration guide]({{< relref "tutorials/migrate-from-jekyll.md" >}}) or use the new [Jekyll import command]({{< relref "commands/hugo_import_jekyll.md" >}}). - -- [JekyllToHugo](https://github.com/SenjinDarashiva/JekyllToHugo) - A Small script for converting Jekyll blog posts to a Hugo site. -- [ConvertToHugo](https://github.com/coderzh/ConvertToHugo) - Convert your blog from Jekyll to Hugo. - -### Ghost - -- [ghostToHugo](https://github.com/jbarone/ghostToHugo) - Convert Ghost blog posts and export them to Hugo. - -### Octopress - -- [octohug](https://github.com/codebrane/octohug) - Octopress to Hugo migrator. - -### DokuWiki - -- [dokuwiki-to-hugo](https://github.com/wgroeneveld/dokuwiki-to-hugo) - Migrates your dokuwiki source pages from [DokuWiki syntax](https://www.dokuwiki.org/wiki:syntax) to Hugo Markdown syntax. Includes extra's like the TODO plugin. Written with extensibility in mind using python 3. Also generates a TOML header for each page. Designed to copypaste the wiki directory into your /content directory. - -### WordPress - -- [wordpress-to-hugo-exporter](https://github.com/SchumacherFM/wordpress-to-hugo-exporter) - A one-click WordPress plugin that converts all posts, pages, taxonomies, metadata, and settings to Markdown and YAML which can be dropped into Hugo. (Note: If you have trouble using this plugin, you can [export your site for Jekyll](https://wordpress.org/plugins/jekyll-exporter/) and use Hugo's built in Jekyll converter listed above.) - -### Tumblr - -- [tumblr-importr](https://github.com/carlmjohnson/tumblr-importr) - An importer that uses the Tumblr API to create a Hugo static site. -- [tumblr2hugomarkdown](https://github.com/Wysie/tumblr2hugomarkdown) - Export all your Tumblr content to Hugo Markdown files with preserved original formatting. -- [Tumblr to Hugo](https://github.com/jipiboily/tumblr-to-hugo) - A migration tool that converts each of your Tumblr posts to a content file with a proper title and path. Furthermore, "Tumblr to Hugo" creates a CSV file with the original URL and the new path on Hugo, to help you setup the redirections. - -### Drupal - -- [drupal2hugo](https://github.com/danapsimer/drupal2hugo) - Convert a Drupal site to Hugo. - -### Joomla - -- [hugojoomla](https://github.com/davetcc/hugojoomla) - This utility written in Java takes a Joomla database and converts all the content into Markdown files. It changes any URLs that are in Joomla's internal format and converts them to a suitable form. - -### Blogger - -- [blogimport](https://github.com/natefinch/blogimport) - A tool to import from Blogger posts to Hugo. - -### Contentful - -- [contentful2hugo](https://github.com/ArnoNuyts/contentful2hugo) - A tool to create content-files for Hugo from content on [Contentful](https://www.contentful.com/). - ----- - -## Deployment - -If you don't want to use [Wercker for automated deployments]({{< relref "tutorials/automated-deployments.md" >}}), give these tools a try to get your content to the public: - -- [hugomac](https://github.com/nickoneill/hugomac) - Hugomac is an OS X menubar app to publish your blog directly to Amazon S3. No command line is needed. -- [hugo-lambda](https://github.com/ryansb/hugo-lambda) - A wrapper around the Hugo static site generator to have it run in AWS Lambda whenever new (Markdown or other) content is uploaded. -- [hugodeploy](https://github.com/mindok/hugodeploy) - Simple SFTP deployment tool for static websites (e.g. created by Hugo) with optional minification. -- [webhook](https://github.com/adnanh/webhook) - Run build and deployment scripts (e.g. hugo) on incoming webhooks -- [Hugo SFTP Upload](https://github.com/thomasmey/HugoSftpUpload) - Sync the local build of your Hugo website with your remote webserver via SFTP. - ----- - -## Frontends - -Do you prefer an graphical user interface over a text editor? Then give these frontends a try: - -- [enwrite](https://github.com/zzamboni/enwrite) - Evernote-powered statically-generated blogs and websites. Now posting to your blog or updating your website is as easy as writing a new note in Evernote! -- [caddy-hugo](https://github.com/hacdias/caddy-hugo) - This is an add-on for [Caddy](https://caddyserver.com/) which wants to deliver a good UI to edit the content of the website. -- [Lipi](https://github.com/SohanChy/Lipi) - A native GUI frontend written in Java to manage your Hugo websites. - ----- - -## Editor plugins - -If you still want to use an editor, look at these plugins to automate your workflow: - -### Sublime Text - -- [Hugofy](https://github.com/akmittal/Hugofy) - Hugofy is a plugin for Sublime Text 3 to make life easier to use Hugo static site generator. - -### Visual Studio Code - -- [Hugofy](https://marketplace.visualstudio.com/items?itemName=akmittal.hugofy) - Hugofy is a plugin for Visual Studio Code to make life easier to use Hugo static site generator. The source code can be found [here](https://github.com/akmittal/hugofy-vscode). - -### Emacs - -- [easy-hugo](https://github.com/masasam/emacs-easy-hugo) - Major mode & tools for Hugo. -- [hugo.el](https://github.com/yewton/hugo.el) - Some helper functions for creating a Website with Hugo. - -### Vim - -- [Vim Hugo Helper](https://github.com/robertbasic/vim-hugo-helper) - A small Vim plugin to help me with writing posts with Hugo. - -### Atom - -- [Hugofy](https://atom.io/packages/hugofy) - A Hugo Static Website Generator package for Atom - ----- - -## Search - -A static site with a dynamic search function? Yes. Alternatively to embeddable scripts from Google or other search engines you can provide your visitors a custom search by indexing your content files directly. - -- [Hugoidx](https://github.com/blevesearch/hugoidx) is an experimental application to create a search index. It's build on top of [Bleve](http://www.blevesearch.com/). -- This [GitHub Gist](https://gist.github.com/sebz/efddfc8fdcb6b480f567) contains simple workflow to create a search index for your static site. It uses a simple Grunt script to index all your content files and [lunr.js](http://lunrjs.com/) to serve the search results. -- [hugo-lunr](https://www.npmjs.com/package/hugo-lunr) - A simple way to add site search to your static Hugo site using [lunr.js](http://lunrjs.com/). Hugo-lunr will create an index file of any html and markdown documents in your Hugo project. - ----- - -## Commercial Services - -- [Algolia](https://www.algolia.com/)'s Search API makes it easy to deliver a great search experience in your apps & websites. Algolia Search provides hosted full-text, numerical, faceted and geolocalized search. - -- [Appernetic.io](https://appernetic.io) is a Hugo Static Site Generator as a Service that is easy to use for non-technical users. -Features: inline PageDown editor, visual tree view, image upload and digital asset management with Cloudinary, site preview, continuous integration with GitHub, atomic deploy and hosting, Git and Hugo integration, autosave, custom domain, project syncing, theme cloning and management. Developers have complete control over the source code and can manage it with GitHub's deceptively simple workflow. - -- [Netlify.com](https://www.netlify.com), builds, deploy & hosts your static site or app (Hugo, Jekyll etc). Build, deploy and host your static site or app with a drag and drop interface and automatic deploys from GitHub or Bitbucket. -Features: global CDN, atomic deploys, ultra fast DNS, instant cache invalidation, high availability, automated hosting, Git integration, form submission hooks, authentication providers, custom domain. Developers have complete control over the source code and can manage it with GitHub's or Bitbuckets deceptively simple workflow. - -- [Forestry.io](https://forestry.io/) - A simple CMS for Jekyll and Hugo sites with support for GitHub, GitLab and Bitbucket. Every time an update is made via the CMS, Forestry will commit changes back to your repo and will compile/deploy your site (S3, GitHub Pages, FTP, etc). - ----- - -## Other - -And for all the other small things around Hugo: - -- [hugo-gallery](https://github.com/icecreammatt/hugo-gallery) lets you create an image gallery for Hugo sites. -- [flickr-hugo-embed](https://github.com/nikhilm/flickr-hugo-embed) prints shortcodes to embed a set of images from an album on Flickr into Hugo. -- [hugo-openapispec-shortcode](https://github.com/tenfourty/hugo-openapispec-shortcode) A shortcode which allows you to include [Open API Spec](https://openapis.org) (formerly known as Swagger Spec) in a page. -- [HugoPhotoSwipe](https://github.com/GjjvdBurg/HugoPhotoSwipe) makes it easy to create image galleries using PhotoSwipe. diff --git a/docs/content/troubleshooting/categories-with-accented-characters.md b/docs/content/troubleshooting/categories-with-accented-characters.md deleted file mode 100644 index 386fbecf6..000000000 --- a/docs/content/troubleshooting/categories-with-accented-characters.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -lastmod: 2015-01-08 -date: 2015-01-08T16:32:00-07:00 -menu: - main: - parent: troubleshooting -title: Accented Categories -weight: 10 ---- - -## Trouble: Categories with accented characters - -One of my categories is named "Le-carré," but the link ends up being generated like this: - - categories/le-carr%C3%A9 - -And not working. Is there an easy fix for this that I'm overlooking? - - -## Solution - -Mac OS X user? If so, you are likely a victim of HFS Plus file system's insistence to store the "é" (U+00E9) character in Normal Form Decomposed (NFD) mode, i.e. as "e" + " ́" (U+0065 U+0301). - -`le-carr%C3%A9` is actually correct, `%C3%A9` being the UTF-8 version of U+00E9 as expected by the web server. Problem is, OS X turns [U+00E9] into [U+0065 U+0301], and thus `le-carr%C3%A9` no longer works. Instead, only `le-carre%CC%81` ending with `e%CC%81` would match that [U+0065 U+0301] at the end. - -This is unique to OS X. The rest of the world does not do this, and most certainly not your web server which is most likely running Linux. This is not a Hugo-specific problem either. Other people have been bitten by this when they have accented characters in their HTML files. - -Nor is this problem specific to Latin scripts. Japanese Mac users often run into the same issue, e.g. with `だ` decomposing into `た` and <code>゙</code>.[^1] - -Rsync 3.x to the rescue! From [an answer posted on Server Fault](http://serverfault.com/questions/397420/converting-utf-8-nfd-filenames-to-utf-8-nfc-in-either-rsync-or-afpd): - -> You can use rsync's `--iconv` option to convert between UTF-8 NFC & NFD, at least if you're on a Mac. There is a special `utf-8-mac` character set that stands for UTF-8 NFD. So to copy files from your Mac to your web server, you'd need to run something like: -> -> `rsync -a --iconv=utf-8-mac,utf-8 localdir/ mywebserver:remotedir/` -> -> This will convert all the local filenames from UTF-8 NFD to UTF-8 NFC on the remote server. The files' contents won't be affected. - -Please make sure you have the latest version rsync 3.x installed. The rsync that ships with OS X (even the latest 10.10 Yosemite) is the horribly old at version 2.6.9 protocol version 29. The `--iconv` flag is new in rsync 3.x. - -### References - -* http://discuss.gohugo.io/t/categories-with-accented-characters/505 -* [Converting UTF-8 NFD filenames to UTF-8 NFC, in either rsync or afpd](http://serverfault.com/questions/397420/converting-utf-8-nfd-filenames-to-utf-8-nfc-in-either-rsync-or-afpd) (Server Fault) -* http://wiki.apache.org/subversion/NonNormalizingUnicodeCompositionAwareness -* https://en.wikipedia.org/wiki/Unicode_equivalence#Example -* http://zaiste.net/2012/07/brand_new_rsync_for_osx/ -* https://gogo244.wordpress.com/2014/09/17/drived-me-crazy-convert-utf-8-mac-to-utf-8/ - - -[^1]: As explained in the Japanese Perl Users article [Encode::UTF8Mac makes you happy while handling file names on MacOSX](http://perl-users.jp/articles/advent-calendar/2010/english/24). diff --git a/docs/content/troubleshooting/overview.md b/docs/content/troubleshooting/overview.md deleted file mode 100644 index 513ca105c..000000000 --- a/docs/content/troubleshooting/overview.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -lastmod: 2015-01-27 -date: 2015-01-18T02:41:52-07:00 -menu: - main: - parent: troubleshooting -title: Troubleshooting Overview -weight: 0 ---- - -Got stuck? Worry not! Chances are other users have encountered -the exact same problem as you have, brought it up for -[discussion](http://discuss.gohugo.io/), and have likely found a solution -through the collective wisdom of our vibrant Hugo community! - -Here are some examples: - -* [`hugo new` aborts with cryptic EOF error](/troubleshooting/strange-eof-error/) (affects v0.12 and lower) -* [Categories with accented characters inaccessible](/troubleshooting/categories-with-accented-characters/) (affects Mac OS X users) -* [My CSS files aren't loaded!](http://discuss.gohugo.io/t/deployment-workflow/90/15) -* [How do I include an image gallery on my website?](http://discuss.gohugo.io/t/image-gallery/594) -* ... And a lot more! - -{{% youtube c8fJIRNChmU %}} - -Indeed, you may find many questions and solutions -to problems in our [discussion forum](http://discuss.gohugo.io/), -and you may find the [support](http://discuss.gohugo.io/category/support) -and [tips & tricks](http://discuss.gohugo.io/category/tips-tricks) -categories particularly helpful. - -Can't find anything? Please write on the forum and post your questions -and comments! Sometimes, your feedback may lead to the discovery of -existing bugs in the code or in the documentation, and may even spur -the interest of adding new features to the next Hugo version, improving -Hugo for everybody! (Thank you!) See you on the forum! diff --git a/docs/content/troubleshooting/strange-eof-error.md b/docs/content/troubleshooting/strange-eof-error.md deleted file mode 100644 index 24eb52184..000000000 --- a/docs/content/troubleshooting/strange-eof-error.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -lastmod: 2015-01-17 -date: 2015-01-08T16:11:23-07:00 -menu: - main: - parent: troubleshooting -title: Strange EOF error -weight: 5 ---- - -## Trouble: `hugo new` aborts with cryptic EOF error - -> I'm running into an issue where I cannot get archetypes working, when running `hugo new showcase/test.md`, for example, I see an `EOF` error thrown by Hugo. -> -> I have set up this test repository to show exactly what I've done, but it is essentially a vanilla installation of Hugo. https://github.com/polds/hugo-archetypes-test -> -> When in that repository, using Hugo v0.12 to run `hugo new -v showcase/test.md`, I see the following output: -> -> INFO: 2015/01/04 Using config file: /private/tmp/test/config.toml -> INFO: 2015/01/04 attempting to create showcase/test.md of showcase -> INFO: 2015/01/04 curpath: /private/tmp/test/archetypes/showcase.md -> ERROR: 2015/01/04 EOF -> -> Is there something that I am blatantly missing? - -## Solution - -Thank you for reporting this issue. The solution is to add a final newline (i.e. EOL) to the end of your default.md archetype file of your theme. More discussions happened on the forum here: - -* http://discuss.gohugo.io/t/archetypes-not-properly-working-in-0-12/544 -* http://discuss.gohugo.io/t/eol-f-in-archetype-files/554 - -Due to popular demand, Hugo's parser has been enhanced to -accommodate archetype files without final EOL, -thanks to the great work by [@tatsushid](https://github.com/tatsushid), -in the upcoming v0.13 release, - -Until then, for us running the stable v0.12 release, please remember to add the final EOL diligently. <i class="fa fa-smile-o"></i> - -## References - -* https://github.com/gohugoio/hugo/issues/776 - diff --git a/docs/content/tutorials/automated-deployments.md b/docs/content/tutorials/automated-deployments.md deleted file mode 100644 index 9f6d5c628..000000000 --- a/docs/content/tutorials/automated-deployments.md +++ /dev/null @@ -1,275 +0,0 @@ ---- -authors: -- Arjen Schwarz -- Samuel Debruyn -lastmod: 2017-02-26 -date: 2015-01-12 -linktitle: Automated deployments -toc: true -menu: - main: - parent: tutorials -next: /tutorials/creating-a-new-theme -prev: /community/contributing -title: Automated deployments with Wercker -weight: 10 ---- - -# Automated deployments with Wercker - -In this tutorial we will set up a basic Hugo project and then configure a free tool called Wercker to automatically deploy the generated site any time we add an article. We will deploy it to GitHub pages as that is easiest to set up, but you will see that we can use anything. This tutorial takes you through every step of the process, complete with screenshots and is fairly long. - -The assumptions made for this tutorial are that you know how to use git for version control, and have a GitHub account. In case you are unfamiliar with these, in their [help section](https://help.github.com/articles/set-up-git/) GitHub has an explanation of how to install and use git and you can easily sign up for a free GitHub account as well. - -## Creating a basic Hugo site - -There are already [pages](http://gohugo.io/overview/quickstart/) dedicated to describing how to set up a Hugo site so we will only go through the most basic steps required to get a site up and running before we dive into the Wercker configuration. All the work for setting up the project is done using the command line, and kept as simple as possible. - -Create the new site using the `hugo new site` command, and we move into it. - -```bash -hugo new site hugo-wercker-example -cd hugo-wercker-example -``` - -Add the herring-cove theme by cloning it into the theme directory using the following commands. - -```bash -mkdir themes -cd themes -git clone https://github.com/spf13/herring-cove.git -``` - -Cloning the project like this will conflict with our own version control, so we remove the external git configuration. - -```bash -rm -rf herring-cove/.git -``` - -Let's add a quick **about** page. - -```bash -hugo new about.md -``` - -Now we'll edit contents/about.md to ensure it's no longer a draft and add some text to it. - -```bash -hugo undraft content/about.md -``` - -Once completed it's a good idea to do a quick check if everything is working by running - -```bash -hugo server --theme=herring-cove -``` - -If everything is fine, you should be able to see something similar to the image below when you go to localhost:1313 in your browser. - -![][1] - -[1]: /img/tutorials/automated-deployments/creating-a-basic-hugo-site.png - -## Setting up version control - -Adding git to our project is done by running the `git init` command from the root directory of the project. - -```bash -git init -``` - -Running `git status` at this point will show you p entries: the **config.toml** file, the **themes** directory, the **contents** directory, and the **public** directory. We don't want the **public** directory version controlled however, as we will use wercker to generate that later on. Therefore, we'll add a gitignore file that will exclude this using the following command. - -```bash -echo "/public" >> .gitignore -``` - -As we currently have no static files outside of the theme directory, Wercker might complain when we try to build the site later on. To prevent this, we simply have to add any file to the static folder. To keep it simple for now we'll add a robots.txt file that will give all search engines full access to the site when it's up. - -```bash -echo "User-agent: *\nDisallow:" > static/robots.txt -``` - -After this we can add everything to the repository. - -```bash -git commit -a -m "Initial commit" -``` - -## Adding the project to GitHub - -First we'll create a new repository. You can do this by clicking on the **+** sign at the top right, or by going to https://github.com/new - -We then choose a name for the project (**hugo-wercker-example**). When clicking on create repository GitHub displays the commands for adding an existing project to the site. The commands shown below are the ones used for this site, if you're following along you will need to use the ones shown by GitHub. Once we've run those commands the project is in GitHub and we can move on to setting up the Wercker configuration. - -```bash -git remote add origin git@github.com:YourUsername/hugo-wercker-example.git -git push -u origin master -``` - -![][2] - -[2]: /img/tutorials/automated-deployments/adding-the-project-to-github.png - -## Welcome to wercker - -Let's start by setting up an account for Wercker. To do so we'll go to http://wercker.com and click on the **Sign up** button. - -![][3] - -[3]: /img/tutorials/automated-deployments/wercker-sign-up.png - -## Register - -To make life easier for ourselves, we will then register using GitHub. If you don't have a GitHub account, or don't want to use it for your account, you can of course register with a username and password as well. - -![][4] - -[4]: /img/tutorials/automated-deployments/wercker-sign-up-page.png - -## Connect GitHub/Bitbucket - -After you are registered, you will need to link your GitHub and/or Bitbucket account to Wercker. You do this by going to your profile settings, and then "Git connections" If you registered using GitHub it will most likely look like the image below. To connect a missing service, simply click on the connect button which will then send you to either GitHub or Bitbucket where you might need to log in and approve their access to your account. - -![][5] - -[5]: /img/tutorials/automated-deployments/wercker-git-connections.png - -## Add your project - -Now that we've got all the preliminaries out of the way, it's time to set up our application. For this we click on the **+ Create** button next to Applications. Create a new application, and choose to use GitHub. - -![][6] - -[6]: /img/tutorials/automated-deployments/wercker-add-app.png - -## Select a repository - -Clicking this will make Wercker show you all the repositories you have on GitHub, but you can easily filter them as well. So we search for our repository, select it, and then click on "Use selected repo". - -![][7] - -[7]: /img/tutorials/automated-deployments/wercker-select-repository.png - -## Configure access - -As Wercker doesn't access to check out your private projects by default, it will ask you what you want to do. When your project is public, as needs to be the case if you wish to use GitHub Pages, the top choice is recommended. When you use this it will simply check out the code in the same way anybody visiting the project on GitHub can do. - -![][8] - -[8]: /img/tutorials/automated-deployments/wercker-access.png - -## Public or not - -This is a personal choice; you can make an app public so that everyone can see more details about it. This doesn't give you any real benefits either way in general, although as part of the tutorial I have of course made this app public so you can see it in action [yourself](https://app.wercker.com/#applications/5586dcbdaf7de9c51b02b0d5). - -![][9] - -[9]: /img/tutorials/automated-deployments/public-or-not.png - -## Wercker.yml - -Choose Default for your programming language. Wercker will now attempt to create an initial *wercker.yml* file for you. Or rather, it will create the code you can copy into it yourself. Because there is nothing special about our project according to Wercker, we will simply get the `debian` box. So what we do now is create a *wercker.yml* file in the local root of our project that contains the provided configuration, and after we finish setting up the app we will expand this file to make it actually do something. - -![][10] - -[10]: /img/tutorials/automated-deployments/werckeryml.png - -## And we've got an app - -The application is added now, and Wercker will be offering you the chance to trigger a build. As we haven't pushed up the **wercker.yml** file however, we will politely decline this option. Wercker has automatically added a build pipeline to your application. - -## Adding build step - -And now we're going to add the build step to the build pipeline. First, we go to the "Registry" action in the top menu and then search for "hugo build". Find the **Hugo-Build** task by Arjen and select it. - -![][11] - -[11]: /img/tutorials/automated-deployments/wercker-search.png - -## Using Hugo-Build - -Inside the details of this step you will see how to use it. At the top is a summary for very basic usage, but when scrolling down you go through the README of the step which will usually contain more details about the advanced options available and a full example of using the step. - -We're not going to use any of the advanced features in this tutorial, so we'll return to our project and add the details we need to our wercker.yml file so that it looks like below: - -```yaml -box: debian -build: - steps: - - install-packages: - packages: git - - script: - name: download theme - code: | - $(git clone https://github.com/spf13/herring-cove ./themes/herring-cove) - - arjen/hugo-build: - version: "0.14" - theme: herring-cove - flags: --buildDrafts=true -``` - -As you can see, we have two steps in the build pipeline. The first step downloads the theme, and the second step runs arjen's hugo-build step. To use a different theme, you can replace the link to the herring-cove source with another theme's repository - just make sure the name of the folder you download the theme to (./themes/your-theme-name) matches the theme name you tell arjen/hugo-build to use (theme: your-theme-name). Now we'll test that it all works as it should by pushing up our wercker.yml file to GitHub and seeing the magic at work. - -```bash -git commit -a -m "Add wercker.yml" -git push origin master -``` - -Once completed a nice tick should have appeared in front of your first build, and if you want you can look at the details by clicking on it. However, we're not done yet as we still need to deploy it to GitHub Pages. - -![][12] - -[12]: /img/tutorials/automated-deployments/using-hugo-build.png - -## Adding a deploy pipeline - -In order to deploy to GitHub Pages we need to add a deploy pipeline. - -1. First, go to your Wercker application's page. Go to the "Workflows" tab and click on "Add new pipeline." Name it whatever you want; "deploy-production" or "deploy" works fine. For your YML Pipeline name, type in "deploy" without quotes. Leave the hook type as "Default" and hit the Create button. - -2. Now you need to link the deploy pipeline to your build pipeline. In the workflow editor, click on the + next to your build pipeline and add the deploy pipeline you've just made. Now the deploy pipeline will be run automatically whenever the build pipeline is completed successfully. - -![][13] - -[13]: /img/tutorials/automated-deployments/adding-a-deploy-pipeline.png - -## Adding a deploy step - -Next, we need to add a step to our deploy pipeline that will deploy the Hugo-built website to your GitHub pages repository. Once again searching through the Steps registry, we find that the most popular step is the **lukevevier/gh-pages** step so we add the configuration for that to our wercker.yml file. Additionally, we need to ensure that the box we run on has git and ssh installed. We can do this using the **install-packages** command, which then turns the wercker.yml file into this: - -```yaml -box: debian -build: - steps: - - arjen/hugo-build: - version: "0.14" - theme: herring-cove - flags: --buildDrafts=true -deploy: - steps: - - install-packages: - packages: git ssh-client - - lukevivier/gh-pages@0.2.1: - token: $GIT_TOKEN - domain: hugo-wercker.ig.nore.me - basedir: public -``` - -How does the GitHub Pages configuration work? We've selected a couple of things, first the domain we want to use for the site. Configuring this here will ensure that GitHub Pages is aware of the domain you want to use. - -Secondly we've configured the basedir to **public**, this is the directory that will be used as the website on GitHub Pages. - -And lastly, you can see here that this has a **$GIT_TOKEN** variable. This is used for pushing our changes up to GitHub and we will need to configure this before we can do that. To do this, go to your application page and click on the "Environment" tab. Under Application Environment Variables, put **$GIT_TOKEN** for the Key. Now you'll need to create an access token in GitHub. How to do that is described on a [GitHub help page](https://help.github.com/articles/creating-an-access-token-for-command-line-use/). Copy and paste the access token you generated from GitHub into the Value box. **Make sure you check Protected** and then hit Add. - -![][14] - -[14]: /img/tutorials/automated-deployments/adding-a-deploy-step.png - -With the deploy step configured in Wercker, we can push the updated wercker.yml file to GitHub and it will create the GitHub pages site for us. The example site we used here is accessible under hugo-wercker.ig.nore.me - -## Conclusion - -From now on, any time you want to put a new post on your blog all you need to do is push your new page to GitHub and the rest will happen automatically. The source code for the example site used here is available on [GitHub](https://github.com/ArjenSchwarz/hugo-wercker-example), as is the [Hugo Build step](https://github.com/ArjenSchwarz/wercker-step-hugo-build) itself. - -If you want to see an example of how you can deploy to S3 instead of GitHub pages, take a look at [Wercker's documentation](http://devcenter.wercker.com/docs/deploy/s3.html) about how to set that up. diff --git a/docs/content/tutorials/create-a-multilingual-site.md b/docs/content/tutorials/create-a-multilingual-site.md deleted file mode 100644 index 8a2dd960e..000000000 --- a/docs/content/tutorials/create-a-multilingual-site.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -author: "Rick Cogley" -lastmod: 2015-12-24 -date: 2015-07-08 -linktitle: Multilingual Site -menu: - main: - parent: tutorials -prev: /tutorials/migrate-from-jekyll -title: Create a Multilingual Site -weight: 10 ---- - -> **Note:** Since v0.17 Hugo has built-in support for the creation of multilingual website. [Read more about it]({{< relref "content/multilingual.md" >}}). - -## Introduction - -Hugo allows you to create a multilingual site from its built-in tools. This tutorial will show one way to do it, and assumes: - -* You already know the basics about creating a Hugo site -* You have a separate domain name for each language -* You'll use `/data` files for some translation strings -* You'll use single, combined `layout` and `static` folders -* You'll use a subfolder for each language under `content` and `public` - -## Site Configs - -Create your site configs in the root of your repository, for example for an English and Japanese site. - -**English Config `config_en.toml`**: - -~~~toml -baseURL = "http://acme.com/" -title = "Acme Inc." -contentDir = "content/en" -publishDir = "public/en" - -[params] - locale = "en-US" -~~~ - -**Japanese Config `config_ja.toml`**: - -~~~toml -baseURL = "http://acme.jp/" -title = "有限会社アクミー" -contentDir = "content/ja" -publishDir = "public/ja" - -[params] - locale = "ja-JP" -~~~ - -If you had more domains and languages, you would just create more config files. The standard `config.toml` is what Hugo will run as a default, but since we're creating language-specific ones, you'll need to specify each config file when running `hugo server` or just `hugo` before deploying. - -## Prep Translation Strings in `/data` - -Create `.yaml` (or `.json` or `.toml`) files for each language, under `/data/translations`. - -**English Strings `en-US.yaml`**: - -~~~yaml -topSlogan: Acme Inc. -topSubslogan: You'll love us -... -~~~ - -**Japanese Strings `ja-JP.yaml`**: - -~~~yaml -topSlogan: 有限会社アクミー -topSubslogan: キット勝つぞ -... -~~~ - -In some cases, where there is more complex formatting within the strings you want to show, it might be better to employ some conditional logic in your template, to display a block of html per language. - -## Reference Strings in templates - -Now you can reference the strings in your templates. One way is to do it like in this `layouts/index.html`, leveraging the fact that you have the locale set: - -~~~html -<!DOCTYPE html> -<html lang="{{ .Site.Params.locale }}"> -... - <head> - <meta charset="utf-8"> - <title>{{ if eq .Site.Params.locale "en-US" }}{{ if .IsHome }}Welcome to {{ end }}{{ end }}{{ .Title }}{{ if eq .Site.Params.locale "ja-JP" }}{{ if .IsHome }}へようこそ{{ end }}{{ end }}{{ if ne .Title .Site.Title }} : {{ .Site.Title }}{{ end }}</title> - ... - </head> - <body> - <div class="container"> - <h1 class="header">{{ ( index $.Site.Data.translations $.Site.Params.locale ).topSlogan }}</h1> - <h3 class="subheader">{{ ( index $.Site.Data.translations $.Site.Params.locale ).topSubslogan }}</h3> - </div> - </body> -</html> -~~~ - -The above shows both techniques, using an `if eq` and `else if eq` to check the locale, and using `index` to pull strings from the data file that matches the locale set in the site's config file. - -## Customize Dates - -At the time of this writing, Golang does not yet have support for internationalized locales, but if you do some work, you can simulate it. For example, if you want to use French month names, you can add a data file like ``data/mois.yaml`` with this content: - -~~~toml -1: "janvier" -2: "février" -3: "mars" -4: "avril" -5: "mai" -6: "juin" -7: "juillet" -8: "août" -9: "septembre" -10: "octobre" -11: "novembre" -12: "décembre" -~~~ - -... then index the non-English date names in your templates like so: - -~~~html -<time class="post-date" datetime="{{ .Date.Format "2006-01-02T15:04:05Z07:00" | safeHTML }}"> - Article publié le {{ .Date.Day }} {{ index $.Site.Data.mois (printf "%d" .Date.Month) }} {{ .Date.Year }} (dernière modification le {{ .Lastmod.Day }} {{ index $.Site.Data.mois (printf "%d" .Lastmod.Month) }} {{ .Lastmod.Year }}) -</time> -~~~ - -This technique extracts the day, month and year by specifying ``.Date.Day``, ``.Date.Month``, and ``.Date.Year``, and uses the month number as a key, when indexing the month name data file. - -## Create Multilingual Content - -Now you can create markdown content in your languages, in the `content/en` and `content/ja` folders. The frontmatter stays the same on the key side, but the values would be set in each of the languages. - -## Run Hugo Server or Deploy Commands - -Once you have things set up, you can run `hugo server` or `hugo` before deploying. You can create scripts to do it, or as shell functions. Here are sample basic `zsh` functions: - -**Live Reload with `hugo server`**: - -~~~shell -function hugoserver-com { - cd /Users/me/dev/mainsite - hugo server --buildDrafts --verbose --source="/Users/me/dev/mainsite" --config="/Users/me/dev/mainsite/config_en.toml" --port=1377 -} -function hugoserver-jp { - cd /Users/me/dev/mainsite - hugo server --buildDrafts --verbose --source="/Users/me/dev/mainsite" --config="/Users/me/dev/mainsite/config_ja.toml" --port=1399 -} -~~~ - -**Deploy with `hugo` and `rsync`**: - -~~~shell -function hugodeploy-acmecom { - rm -rf /tmp/acme.com - hugo --config="/Users/me/dev/mainsite/config_en.toml" -s /Users/me/dev/mainsite/ -d /tmp/acme.com - rsync -avze "ssh -p 22" --delete /tmp/acme.com/ me@mywebhost.com:/home/me/webapps/acme_com_site -} - -function hugodeploy-acmejp { - rm -rf /tmp/acme.jp - hugo --config="/Users/me/dev/mainsite/config_ja.toml" -s /Users/me/dev/mainsite/ -d /tmp/acme.jp - rsync -avze "ssh -p 22" --delete /tmp/acme.jp/ me@mywebhost.com:/home/me/webapps/acme_jp_site -} -~~~ - -Adjust to fit your situation, setting dns, your webserver config, and other settings as appropriate. diff --git a/docs/content/tutorials/creating-a-new-theme.md b/docs/content/tutorials/creating-a-new-theme.md deleted file mode 100644 index a0b95b5e6..000000000 --- a/docs/content/tutorials/creating-a-new-theme.md +++ /dev/null @@ -1,1717 +0,0 @@ ---- -author: "Michael Henderson" -lastmod: 2016-09-01 -date: 2015-11-26 -linktitle: Creating a New Theme -menu: - main: - parent: tutorials -next: /tutorials/github-pages-blog -prev: /tutorials/automated-deployments -title: Creating a New Theme -weight: 10 ---- -## Introduction - -This tutorial will show you how to create a simple theme in Hugo. - -I'll introduce Hugo's use of templates, -and explain how to organize them into a theme. -The theme will grow, minimizing effort while meeting evolving needs. -To promote this focus, and to keep everything simple, I'll omit CSS styling. - -We'll start by creating a tiny, blog-like web site. -We'll implement this blog with just one — quite basic — template. -Then we'll add an About page, and a few articles. -Overall, this web site (along with what you learn here) -will provide a good basis for you to continue working with Hugo in the future. -By making small variations, -you'll be able to create many different kinds of web sites. - -I will assume you're comfortable with HTML, Markdown formatting, -and the Bash command line (possibly using [Git for -Windows](https://git-for-windows.github.io/)). - -A few symbols might call for explanation: in this tutorial, -the commands you'll enter will be preceded by a `$` prompt — -and their output will follow. -`vi` means to open your editor; then `:wq` means to save the file. -Sometimes I'll add comments to explain a point — these start with `#`. -So, for example: -```bash -# this is a comment -$ echo this is a command -this is a command - -# edit the file -$ vi foo.md -+++ -date = "2040-01-18" -title = "creating a new theme" - -+++ -Bah! Humbug! -:wq - -# show it -$ cat foo.md -+++ -date = "2040-01-18" -title = "creating a new theme" - -+++ -Bah! Humbug! -``` -## Definitions - -Three concepts: - -1. _Non-content_ files; -1. _Templates_ (as Hugo defines them); and -1. _Front-matter_ - -are essential for creating your first Hugo theme, -as well as your first Hugo website. -### Non-Content - -The source files of a web site (destined to be rendered by Hugo) -are divided into two kinds: - -1. The files containing its textual content (and nothing else — -except Hugo front-matter: see below, and Markdown styling); and -1. All other files. (These contain ***no*** textual content — ideally.) - -Temporarily, let's affix the adjective _non-content_ -to the latter kind of source files. - -Non-content files are responsible for your web site's look and feel. -(Follow these article links from [Bop -Design](https://www.bopdesign.com/bop-blog/2013/11/what-is-the-look-and-feel-of-a-website-and-why-its-important/) -and -[Wikipedia](https://en.wikipedia.org/w/index.php?title=Look_and_feel&oldid=731052704) -if you wish for more information.) -They comprise its images, its CSS (for the sizes, colors and fonts), -its JavaScript (for the actions and reactions), and its Hugo templates -(which contain the rules Hugo uses to transform your content into HTML). - -Given these files, Hugo will render a static web site — -informed by your content — -which contains the above images, HTML, CSS and JavaScript, -ready to be served to visitors. - -Actually, a few of your invariant textual snippets -could reside in non-content files as well. -However, because someone might reuse your theme (eventually), -preferably you should keep those textual snippets in their own content files. -#### Where - -Regarding where to create your non-content files, you have two options. -The simplest is the `./layouts/` and `./static/` filesystem trees. -If you choose this way, -then you needn't worry about configuring Hugo to find them. -Invariably, these are the first two places Hugo seeks for templates -(as well as images, CSS and JavaScript); -so in that case, it's guaranteed to find all your non-content files. - -The second option is to create them in a filesystem tree -located somewhere under the `./themes/` directory. -If you choose that way, -then you must always tell Hugo where to search for them — -that's extra work, though. So, why bother? -#### Theme - -Well — the difference between creating your non-content files under -`./layouts/` and `./static/` and creating them under `./themes/` -is admittedly very subtle. -Non-content files created under `./layouts/` and `./static/` -cannot be customized without editing them directly. -On the other hand, non-content files created under `./themes/` -can be customized, in another way. That way is both conventional -(for Hugo web sites) and non-destructive. Therefore, -creating your non-content files under `./themes/` -makes it easier for other people to use them. - -The rest of this tutorial will call a set of non-content files a ***theme*** -if they comprise a filesystem tree rooted anywhere under the -`./themes/` directory. - -Note that you can use this tutorial to create your set of non-content files -under `./layouts/` and `./static/` if you wish. The only difference is that -you wouldn't need to edit your web site's configuration file -in order to select a theme. -### Home - -The home page, or landing page, -is the first page that many visitors to a web site will see. -Often this is `/index.html`, located at the root URL of the web site. -Since Hugo writes files into the `./public/` tree, -your home page will reside in file `./public/index.html`. -### Configure - -When Hugo runs, it first looks for an overall configuration file, -in order to read its settings, and applies them to the entire web site. -These settings override Hugo's default values. - -The file can be in TOML, YAML, or JSON format. -I prefer TOML for my configuration files. -If you prefer JSON or YAML, you'll need to translate my examples. -You'll also need to change the basename, since Hugo uses its extension -to determine how to process it. - -Hugo translates Markdown files into HTML. -By default, Hugo searches for Markdown files in the `./content/` tree -and template files under the `./themes/` directory. -It will render HTML files to the `./public/` tree. -You can override any of these defaults by specifying alternative locations -in the configuration file. -### Template - -_Templates_ direct Hugo in rendering content into HTML; -they bridge content and presentation. - -Rules in template files determine which content is published and where, -and precisely how it will be rendered into HTML files. -Templates also guide your web site's presentation -by specifying the CSS styling to use. - -Hugo uses its knowledge of each piece of content -to seek a template file to use in rendering it. -If it can't find a template that matches the content, it will zoom out, -one conceptual level; it will then resume the search from there. -It will continue to do so, till it finds a matching template, -or runs out of templates to try. -Its last resort is your web site's default template, -which could conceivably be missing. If it finds no suitable template, -it simply forgoes rendering that piece of content. - -It's important to note that _front-matter_ (see next) -can influence Hugo's template file selection process. -### Content - -Content is stored in text files which contain two sections. -The first is called _front-matter_: this is information about the content. -The second contains Markdown-formatted text, -destined for conversion to HTML format. -#### Front-Matter - -The _front-matter_ is meta-information describing the content. -Like the web site's configuration file, it can be written in the -TOML, YAML, or JSON formats. -Unlike the configuration file, Hugo doesn't use the file's extension -to determine the format. -Instead, it looks for markers in the file which signal this. -TOML is surrounded by "`+++`" and YAML by "`---`", but -JSON is enclosed in curly braces. I prefer to use TOML. -You'll need to translate my examples if you prefer YAML or JSON. - -Hugo informs its chosen template files with the front-matter information -before rendering the content in HTML. -#### Markdown - -Content is written in Markdown format, which makes it easy to create. -Hugo runs the content through a Markdown engine to transform it into HTML, -which it then renders to the output file. -### Template Kinds - -Here I'll discuss three kinds of Hugo templates: -_Single_, _List_, and _Partial_. -All these kinds take one or more pieces of content as input, -and transform the pieces, based on commands in the template. -#### Single - -A _Single_ template is used to render one piece of content. -For example, an article or a post is a single piece of content; -thus, it uses a Single template. -#### List - -A _List_ template renders a group of related content items. -This could be a summary of recent postings, -or all of the articles in a category. -List templates can contain multiple groups (or categories). - -The home page template is a special kind of List template. -This is because Hugo assumes that your home page will act as a portal -to all of the remaining content on your web site. -#### Partial - -A _Partial_ template is a template that's incapable of producing a web page, -by itself. To include a Partial template in your web site, -another template must call it, using the `partial` command. - -Partial templates are very handy for rolling up common behavior. -For example, you might want the same banner to appear on all -of your web site's pages — so, rather than copy your banner's text -into multiple content files, -as well as the other information relevant to your banner -into multiple template files (both Single and List), -you can instead create just one content file and one Partial template. -That way, whenever you decide to change the banner, you can do so -by editing one file only (or maybe two). -## Site - -Let's let Hugo help you create your new web site. -The `hugo new site` command will generate a skeleton — -it will give you a basic directory structure, along with -a usable configuration file: -```bash -$ cd /tmp/ - -$ hugo new site mySite - -$ cd mySite/ - -$ ls -l -total 8 -drwxr-xr-x 2 {user} {group} 68 {date} archetypes --rw-r--r-- 1 {user} {group} 107 {date} config.toml -drwxr-xr-x 2 {user} {group} 68 {date} content -drwxr-xr-x 2 {user} {group} 68 {date} data -drwxr-xr-x 2 {user} {group} 68 {date} layouts -drwxr-xr-x 2 {user} {group} 68 {date} static -drwxr-xr-x 2 {user} {group} 68 {date} themes -``` -Take a look in the `./content/` and `./themes/` directories to confirm -they are empty. - -The other directories -(`./archetypes/`, `./data/`, `./layouts/` and `./static/`) -are used for customizing a named theme. -That's a topic for a different tutorial, so please ignore them for now. -### Render - -Running the `hugo` command with no options will read -all of the available content and render the HTML files. Also, it will copy -all the static files (that's everything besides content). -Since we have an empty web site, Hugo won't be doing much. -However, generally speaking, Hugo does this very quickly: -```bash -$ hugo --verbose -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -WARN: {date} {source} No theme set -INFO: {date} {source} /tmp/mySite/static/ is the only static directory available to sync from -INFO: {date} {source} syncing static files to /tmp/mySite/public/ -Started building site -WARN: {date} {source} Unable to locate layout for homepage: [index.html _default/list.html] -WARN: {date} {source} "/" is rendered empty -============================================================= -Your rendered home page is blank: /index.html is zero-length - * Did you specify a theme on the command-line or in your - "config.toml" file? (Current theme: "") -============================================================= -WARN: {date} {source} Unable to locate layout for 404 page: [404.html] -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -0 pages created -0 non-page files copied -0 paginator pages created -0 tags created -0 categories created -in 4 ms -``` -The "`--verbose`" flag gives extra information that will be helpful -whenever we are developing a template. -Every line of the output starting with "INFO:" or "WARN:" is present -because we used that flag. The lines that start with "WARN:" -are warning messages. We'll go over them later. - -We can verify that the command worked by looking at the directory again: -```bash -$ ls -l -total 8 -drwxr-xr-x 2 {user} {group} 68 {date} archetypes --rw-r--r-- 1 {user} {group} 107 {date} config.toml -drwxr-xr-x 2 {user} {group} 68 {date} content -drwxr-xr-x 2 {user} {group} 68 {date} data -drwxr-xr-x 2 {user} {group} 68 {date} layouts -drwxr-xr-x 6 {user} {group} 204 {date} public -drwxr-xr-x 2 {user} {group} 68 {date} static -drwxr-xr-x 2 {user} {group} 68 {date} themes -``` -See that new `./public/` directory? -Hugo placed all its rendered content there. -When you're ready to publish your web site, that's the place to start. -For now, though, let's just confirm we have the files we expect -for a web site with no content: -```bash -$ ls -l public/ -total 16 --rw-r--r-- 1 {user} {group} 0 {date} 404.html --rw-r--r-- 1 {user} {group} 0 {date} index.html --rw-r--r-- 1 {user} {group} 511 {date} index.xml --rw-r--r-- 1 {user} {group} 210 {date} sitemap.xml -``` -Hugo rendered two XML files and some empty HTML files. -The XML files are used for RSS feeds. Hugo has an opinion about what -those feeds should contain, so it populated those files. -Hugo has no opinion on the look or content of your web site, -so it left those files empty. - -If you look back at the output from the `hugo server` command, -you'll notice that Hugo said: -```bash -0 pages created -``` -That's because Hugo doesn't count the home page, the 404 error page, -or the RSS feed files as pages. -### Serve - -Let's verify you can run the built-in web server — -that'll shorten your development cycle, dramatically. -Start it, by running the `hugo server` command. -If successful, you'll see output similar to the following: -```bash -$ hugo server --verbose -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -WARN: {date} {source} No theme set -INFO: {date} {source} /tmp/mySite/static/ is the only static directory available to sync from -INFO: {date} {source} syncing static files to / -WARN: {date} {source} Unable to locate layout for homepage: [index.html _default/list.html] -WARN: {date} {source} "/" is rendered empty -============================================================= -Your rendered home page is blank: /index.html is zero-length - * Did you specify a theme on the command-line or in your - "config.toml" file? (Current theme: "") -============================================================= -WARN: {date} {source} Unable to locate layout for 404 page: [404.html] -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -0 pages created -0 non-page files copied -0 paginator pages created -0 tags created -0 categories created -in 3 ms -Watching for changes in /tmp/mySite/{data,content,layouts,static} -Serving pages from memory -Web Server is available at http://localhost:1313/ (bind address 127.0.0.1) -Press Ctrl+C to stop -``` -Connect to the listed URL (it's on the line that begins with -`Web Server is available`). If everything's working correctly, -you should get a page that shows nothing. -### Warnings - -Let's go back and look at some of those warnings again: -```bash -WARN: {date} {source} Unable to locate layout for 404 page: [404.html] -WARN: {date} {source} Unable to locate layout for homepage: [index.html _default/list.html] -``` -The 404 warning is easy to explain — it's because we haven't created -the template file `layouts/404.html`. Hugo uses this to render an HTML file -which serves "page not found" errors. However, -the 404 page is a topic for a separate tutorial. - -Regarding the home page warning: the first layout Hugo looked for was -`layouts/index.html`. Note that Hugo uses this file for the home page only. - -It's good that Hugo lists the files it seeks, when -we give it the verbose flag. For the home page, these files are -`layouts/index.html` and `layouts/_default/list.html`. -Later, we'll cover some rules which explain these paths -(including their basenames). For now, just remember that -Hugo couldn't find a template to use for the home page, and it said so. - -All right! So, now — after these few steps — you have a working -installation, and a web site foundation you can build upon. -All that's left is to add some content, as well as a theme to display it. -## Theme - -Hugo doesn't ship with a default theme. However, a large number of themes -are easily available: for example, at -[hugoThemes](https://github.com/gohugoio/hugoThemes). -Also, Hugo comes with a command to generate them. - -We're going to generate a new theme called Zafta. -The goal of this tutorial is simply to show you how to create -(in a theme) the minimal files Hugo needs in order to display your content. -Therefore, the theme will exclude CSS — -it'll be functional, not beautiful. - -Every theme has its own opinions on content and layout. For example, this -Zafta theme prefers the Type "article" over the Types "blog" or "post." -Strong opinions make for simpler templates, but unconventional opinions -make themes tougher for other users. So when you develop a theme, you should -consider the value of adopting the terms used by themes similar to yours. -### Skeleton - -Let's press Ctrl+C and use the `hugo new theme` command -to generate the skeleton of a theme. The result is a directory structure -containing empty files for you to fill out: -```bash -$ hugo new theme zafta - -$ find themes -type f | xargs ls -l --rw-r--r-- 1 {user} {group} 8 {date} themes/zafta/archetypes/default.md --rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/404.html --rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/_default/list.html --rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/_default/single.html --rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/index.html --rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/partials/footer.html --rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/partials/header.html --rw-r--r-- 1 {user} {group} 1081 {date} themes/zafta/LICENSE.md --rw-r--r-- 1 {user} {group} 450 {date} themes/zafta/theme.toml -``` -The skeleton includes templates (files ending in `.html`), a license file, -a description of your theme (`theme.toml`), and a default archetype file. - -When you're developing a real theme, please remember to fill out files -`theme.toml` and `LICENSE.md`. They're optional, but if you're going to -distribute your theme, it tells the world who to praise (or blame). -It's also important to declare your choice of license, so people will know -whether (or where) they can use your theme. - -Note that the skeleton theme's template files are empty. Don't worry; -we'll change that shortly: -```bash -$ find themes/zafta -name '*.html' | xargs ls -l --rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/404.html --rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/_default/list.html --rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/_default/single.html --rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/index.html --rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/partials/footer.html --rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/partials/header.html -``` -### Select - -Now that we've created a theme we can work with, it's a good idea -to add its name to the configuration file. This is optional, because -it's possible to add "-t zafta" to all your commands. -I like to put it in the configuration file because I like -shorter command lines. If you don't put it in the configuration file, -or specify it on the command line, sometimes you won't get the template -you're expecting. - -So, let's edit your configuration file to add the theme name: -```toml -$ vi config.toml -theme = "zafta" -baseURL = "http://example.org/" -title = "My New Hugo Site" -languageCode = "en-us" -:wq -``` -### Themed Render - -Now that we have a theme (albeit empty), let's render the web site again: -```bash -$ hugo --verbose -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -INFO: {date} {source} using a UnionFS for static directory comprised of: -INFO: {date} {source} Base: /tmp/mySite/themes/zafta/static -INFO: {date} {source} Overlay: /tmp/mySite/static/ -INFO: {date} {source} syncing static files to /tmp/mySite/public/ -Started building site -WARN: {date} {source} "/" is rendered empty -============================================================= -Your rendered home page is blank: /index.html is zero-length - * Did you specify a theme on the command-line or in your - "config.toml" file? (Current theme: "zafta") -============================================================= -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -0 pages created -0 non-page files copied -0 paginator pages created -0 tags created -0 categories created -in 4 ms -``` -Did you notice the output is different? -Two previous warning messages have disappeared, which contained the words -"Unable to locate layout" for your home page and the 404 page. -And, a new informational message tells us Hugo is accessing your theme's tree -(`./themes/zafta/`). - -Let's check the `./public/` directory to see what Hugo rendered: -```bash -$ ls -l public/ -total 16 --rw-r--r-- 1 {user} {group} 0 {date} 404.html -drwxr-xr-x 2 {user} {group} 68 {date} css --rw-r--r-- 1 {user} {group} 0 {date} index.html --rw-r--r-- 1 {user} {group} 511 {date} index.xml -drwxr-xr-x 2 {user} {group} 68 {date} js --rw-r--r-- 1 {user} {group} 210 {date} sitemap.xml -``` -It's similar to what we had before, without a theme. -We'd expect so, since all your theme's templates are empty. But notice: -in `./public/`, Hugo created the `css/` and `js/` directories. -That's because Hugo found them in your theme's `static/` directory: -```bash -$ ls -l themes/zafta/static/ -total 0 -drwxr-xr-x 2 {user} {group} 68 {date} css -drwxr-xr-x 2 {user} {group} 68 {date} js -``` -#### Home - -In a Hugo web site, each kind of page is informed (primarily) by just one -of the many different kinds of templates available; -yet the home page is special, because it gets its own kind of template, -and its own template file. - -Hugo uses template file `layouts/index.html` to render the home page's HTML. -Although Hugo's documentation may state that this file is the home page's -only required template, Hugo's earlier warning message showed it actually -looks for two different templates: -```bash -WARN: {date} {source} Unable to locate layout for homepage: [index.html _default/list.html] -``` -#### Empty - -When Hugo generated your theme, it included an empty home page template. -Whenever Hugo renders your web site, it seeks that same template and uses it -to render the HTML for the home page. Currently, the template file is empty, -so the output HTML file is empty, too. Whenever we add rules to that template, -Hugo will use them in rendering the home page: -```bash -$ find * -name index.html | xargs ls -l --rw-r--r-- 1 {user} {group} 0 {date} public/index.html --rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/index.html -``` -As we'll see later, Hugo follows this same pattern for all its templates. -## Static Files - -Hugo does two things when it renders your web site. -Besides using templates to transform your content into HTML, -it also incorporates your static files. Hugo's rule is simple: -unlike with templates and content, static files aren't transformed. -Hugo copies them over, exactly as they are. - -Hugo assumes that your web site will use both CSS and JavaScript, -so it generates some directories in your theme to hold them. -Remember opinions? Well, Hugo's opinion is that you'll store your CSS -in directory `static/css/`, and your JavaScript in directory `static/js/`. -If you don't like that, you can relocate these directories -or change their names (as long as they remain in your theme's `static/` tree), -or delete them completely. -Hugo is nice enough to offer its opinion; yet it still behaves nicely, -if you disagree: -```bash -$ find themes/zafta/* -type d | xargs ls -dl -drwxr-xr-x 3 {user} {group} 102 {date} themes/zafta/archetypes -drwxr-xr-x 6 {user} {group} 204 {date} themes/zafta/layouts -drwxr-xr-x 4 {user} {group} 136 {date} themes/zafta/layouts/_default -drwxr-xr-x 4 {user} {group} 136 {date} themes/zafta/layouts/partials -drwxr-xr-x 4 {user} {group} 136 {date} themes/zafta/static -drwxr-xr-x 2 {user} {group} 68 {date} themes/zafta/static/css -drwxr-xr-x 2 {user} {group} 68 {date} themes/zafta/static/js -``` -## Theme Development - -Generally (using any kind of software), working on a theme means -changing your files, serving your web site again, and then verifying -the resulting improvements in your browser. -With Hugo, this way of working is quite easy: - -- First purge the `./public/` tree. (This is optional but useful, -if you want to start with a clean slate.) -- Run the built-in Hugo web server. -- Open your web site in a browser — and then: - -1. Edit your theme; -1. Glance at your browser window to see your changes; and -1. Repeat. - -I'll throw in one more opinion: ***never*** directly edit a theme on a live -web site. Instead, always develop ***using a copy***. First, make some changes -to your theme and test them. Afterwards, **when you've got them working,** -copy them to your web site. For added safety, use a tool like Git to keep -some revision history of your content, and of your theme. Believe me: -it's too easy to lose your changes, and your mind! - -Check out the main Hugo web site for information about using Git with Hugo. -### Purge - -When rendering your web site, Hugo will create new files in the `./public/` -tree and update existing ones. But it won't delete files that are -no longer used. For example, files previously rendered with -(what is now) the wrong basename, or in the wrong directory, will remain. -Later, if you leave them, they'll likely confuse you. -Cleaning out your `./public/` files prior to rendering can help. - -When Hugo is running in web server mode (as of version 0.15), -it doesn't actually write the files. Instead, -it keeps all the rendered files in memory. So, you can "clean" up -your files simply by stopping and restarting the web server. -### Serve -#### Watch - -Hugo's watch functionality monitors the relevant content, theme and -(overriding) site trees for filesystem changes, -and renders your web site again automatically, when changes are detected. - -By default, watch is -enabled when in web server mode (`hugo server`), -but disabled for the web site renderer (`hugo`). - -In some use cases, -Hugo's web site renderer should continue running and watch — simply -type `hugo --watch` on the command line. - -Sometimes with Docker containers (and Heroku slugs), -the site sources may live on a read-only filesystem. -In that scenario, it makes no sense -for Hugo's web server to watch for file changes — so -use `hugo server --watch=false`. -#### Reload - -Hugo's built in web server includes -[LiveReload](/extras/livereload/) functionality. When any page is updated -in the filesystem, the web browser is told to refresh its currently-open tabs -from your web site. Usually, this happens faster than you can say, -"Wow, that's totally amazing!" -### Workflow - -Again, -I recommend you use the following commands as the basis for your workflow: -```bash -# purge old files. Hugo will recreate the public directory -$ rm -rf public/ - -# run Hugo in watch mode with LiveReload; -# when you're done, stop the web server -$ hugo server --verbose -Press Ctrl+C to stop -``` -Below is some sample output showing Hugo detecting a change in the home page -template. (Actually, the change is the edit we're about to do.) Once it's -rendered again, the web browser automatically reloads the page. - -(As I said above — it's amazing:) -```bash -$ rm -rf public/ - -$ hugo server --verbose -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -INFO: {date} {source} using a UnionFS for static directory comprised of: -INFO: {date} {source} Base: /tmp/mySite/themes/zafta/static -INFO: {date} {source} Overlay: /tmp/mySite/static/ -INFO: {date} {source} syncing static files to / -Started building site -WARN: {date} {source} "/" is rendered empty -============================================================= -Your rendered home page is blank: /index.html is zero-length - * Did you specify a theme on the command-line or in your - "config.toml" file? (Current theme: "") -============================================================= -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -0 pages created -0 non-page files copied -0 paginator pages created -0 tags created -0 categories created -in 4 ms -Watching for changes in /tmp/mySite/{data,content,layouts,static,themes} -Serving pages from memory -Web Server is available at http://localhost:1313/ (bind address 127.0.0.1) -Press Ctrl+C to stop -INFO: {date} {source} Received System Events: ["/tmp/mySite/themes/zafta/layouts/index.html": WRITE] - -Change detected, rebuilding site -{date} -Template changed /tmp/mySite/themes/zafta/layouts/index.html -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -0 pages created -0 non-page files copied -0 paginator pages created -0 tags created -0 categories created -in 3 ms -``` -## Home Template - -The home page is one of the few special pages Hugo renders automatically. -As mentioned earlier, it looks in your theme's `layouts/` tree for one -of two files: - -1. `index.html` -1. `_default/list.html` - -We could edit the default template, but a good design principle is to edit -the most specific template available. That's not a hard-and-fast rule -(in fact, in this tutorial, we'll break it a few times), -but it's a good generalization. -### Static - -Right now, your home page is empty because you've added no content, -and because its template includes no logic. Let's change that by adding -some text to your home page template (`layouts/index.html`): -```html -$ vi themes/zafta/layouts/index.html -<!DOCTYPE html> -<html> -<body> - <p>Hugo says hello!</p> -</body> -</html> -:wq -``` -Let's press Ctrl+C and render the web site, and then verify the results: -```html -$ rm -rf public/ - -$ hugo --verbose -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -INFO: {date} {source} using a UnionFS for static directory comprised of: -INFO: {date} {source} Base: /tmp/mySite/themes/zafta/static -INFO: {date} {source} Overlay: /tmp/mySite/static/ -INFO: {date} {source} syncing static files to /tmp/mySite/public/ -Started building site -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -0 pages created -0 non-page files copied -0 paginator pages created -0 tags created -0 categories created -in 4 ms - -$ ls -l public/index.html --rw-r--r-- 1 {user} {group} 72 {date} public/index.html - -$ cat public/index.html -<!DOCTYPE html> -<html> -<body> - <p>Hugo says hello!</p> -</body> -</html> -``` -### Dynamic - -A ***dynamic*** home page? Because Hugo is a _static web site_ generator, -the word _dynamic_ seems odd, doesn't it? But this means arranging for your -home page to reflect the content in your web site automatically, -each time Hugo renders it. - -To accomplish that, later we'll add an iterator to your home page template. -## Article - -Now that Hugo is successfully rendering your home page with static content, -let's add more pages to your web site. We'll display some new articles -as a list on your home page; and we'll display each article -on its own page, too. - -Hugo has a command to generate an entry skeleton for new content, -just as it does for web sites and themes: -```bash -$ hugo --verbose new article/First.md -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -INFO: {date} {source} attempting to create article/First.md of article -INFO: {date} {source} curpath: /tmp/mySite/themes/zafta/archetypes/default.md -INFO: {date} {source} creating /tmp/mySite/content/article/First.md -/tmp/mySite/content/article/First.md created - -$ ls -l content/article/ -total 8 --rw-r--r-- 1 {user} {group} 61 {date} First.md -``` -Let's generate a second article, while we're here: -```bash -$ hugo --verbose new article/Second.md -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -INFO: {date} {source} attempting to create article/Second.md of article -INFO: {date} {source} curpath: /tmp/mySite/themes/zafta/archetypes/default.md -INFO: {date} {source} creating /tmp/mySite/content/article/Second.md -/tmp/mySite/content/article/Second.md created - -$ ls -l content/article/ -total 16 --rw-r--r-- 1 {user} {group} 61 {date} First.md --rw-r--r-- 1 {user} {group} 62 {date} Second.md -``` -Let's edit both those articles. Be careful to preserve their front-matter, -but append some text to their bodies, as follows: -```bash -$ vi content/article/First.md -In vel ligula tortor. Aliquam erat volutpat. -Pellentesque at felis eu quam tincidunt dignissim. -Nulla facilisi. - -Pellentesque tempus nisi et interdum convallis. -In quam ante, vulputate at massa et, rutrum -gravida dui. Phasellus tristique libero at ex. -:wq - -$ vi content/article/Second.md -Fusce lacus magna, maximus nec sapien eu, -porta efficitur neque. Aliquam erat volutpat. -Vestibulum enim nibh, posuere eu diam nec, -varius sagittis turpis. - -Praesent quis sapien egestas mauris accumsan -pulvinar. Ut mattis gravida venenatis. Vivamus -lobortis risus id nisi rutrum, at iaculis. -:wq -``` -So, for example, `./content/article/Second.md` becomes: -```toml -$ cat content/article/Second.md -+++ -date = "2040-01-18T21:08:08-06:00" -title = "Second" - -+++ -Fusce lacus magna, maximus nec sapien eu, -porta efficitur neque. Aliquam erat volutpat. -Vestibulum enim nibh, posuere eu diam nec, -varius sagittis turpis. - -Praesent quis sapien egestas mauris accumsan -pulvinar. Ut mattis gravida venenatis. Vivamus -lobortis risus id nisi rutrum, at iaculis. -``` -Let's render the web site, and then verify the results: -```bash -$ rm -rf public/ - -$ hugo --verbose -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -INFO: {date} {source} using a UnionFS for static directory comprised of: -INFO: {date} {source} Base: /tmp/mySite/themes/zafta/static -INFO: {date} {source} Overlay: /tmp/mySite/static/ -INFO: {date} {source} syncing static files to /tmp/mySite/public/ -Started building site -INFO: {date} {source} found taxonomies: map[string]string{"tag":"tags", "category":"categories"} -WARN: {date} {source} "article" is rendered empty -WARN: {date} {source} "article/Second.html" is rendered empty -WARN: {date} {source} "article/First.html" is rendered empty -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -2 pages created -0 non-page files copied -0 paginator pages created -0 tags created -0 categories created -in 7 ms -``` -The output says Hugo rendered ("created") two pages. -Those pages are your new articles: -```bash -$ find public -type f -name '*.html' | xargs ls -l --rw-r--r-- 1 {user} {group} 0 {date} public/404.html --rw-r--r-- 1 {user} {group} 0 {date} public/article/First/index.html --rw-r--r-- 1 {user} {group} 0 {date} public/article/index.html --rw-r--r-- 1 {user} {group} 0 {date} public/article/Second/index.html --rw-r--r-- 1 {user} {group} 72 {date} public/index.html -``` -The new pages are empty, because Hugo rendered their HTML from empty -template files. The home page doesn't show us the new content, either: -```html -$ cat public/index.html -<!DOCTYPE html> -<html> -<body> - <p>Hugo says hello!</p> -</body> -</html> -``` -So, we have to edit the templates, in order to pick up the articles. -### Single & List - -Here again I'll discuss three kinds of Hugo templates. One kind is -the home page template we edited previously; it's applicable only to -the home page. Another kind is Single templates, which render output for -just one content file. The third kind are List templates, which group -multiple pieces of content before rendering output. - -It's important to note that, generally, List templates -(except the home page template) are named `list.html`; -and Single templates are named `single.html`. - -Hugo also has three other kinds of templates: -Partials, _Content Views_, and _Terms_. -We'll give examples of some Partial templates; but otherwise, -we won't go into much detail about these. -### Home - -You'll want your home page to list the articles you just created. -So, let's alter its template file (`layouts/index.html`) to show them. -Hugo runs each template's logic whenever it renders that template's web page -(of course): -```html -$ vi themes/zafta/layouts/index.html -<!DOCTYPE html> -<html> -<body> - {{- range first 10 .Data.Pages }} - <h4><a href="{{ .Permalink }}">{{ .Title }}</a></h4> - {{- end }} -</body> -</html> -:wq -``` -#### Engine - -Hugo uses the [Go language's template -engine](https://gohugo.io/templates/go-templates/). -That engine scans your template files for commands enclosed between -"{{" and "}}" (these are doubled, curly braces — affectionately -known as "mustaches"). - -BTW, a hyphen, if placed immediately after an opening mustache, or -immediately before a closing one, will prevent extraneous newlines. -(This can make Hugo's output look better, when viewed as text.) - -So, the mustache commands in your newly-altered template are: - -1. `range ...` -1. `.Permalink` -1. `.Title` -1. `end` - -The `range` command is an iterator. We're using it to go through the latest -ten pages. (Hugo characterizes some of its HTML output files as "pages," -but not all — see above.) - -Looping through the list of data pages will consider each such HTML file -that Hugo renders (or rather — to speak more precisely — each -such HTML file that Hugo currently calculates it _will_ render). - -It's helpful to remember that Hugo sets some variables, such as `.Data`, quite -early in its overall processing. Hugo loads information from every content -file into that variable, and gives all the templates a chance to process that -variable's contents, before actually rendering any HTML output files. - -`.Permalink` supplies the URL which links to that article's page, and -`.Title` supplies the value of its "title" variable. Hugo obtains this -from the front-matter in the article's Markdown file. - -Automatically, the pages are considered in descending order of the generation -times of their Markdown files (actually, based on the value of the "date" -variable in their front-matter) so that the latest is first (naturally). - -The `end` command signals the end of the range iterator. The engine -loops back to the top of the iterator, whenever it finds `end.` -Everything between `range` and `end` is reevaluated, -each time the engine goes through the iterator. - -For the present template, this means that the titles of your latest -ten pages (or however many exist, if that's less) become the -[textContent](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent) -of an equivalent number of copies Hugo makes, of your level-four -subheading tags (and anchor tags). `.Permalink` enables these to link -to the actual articles. - -Let's render your web site, and then verify the results: -```html -$ rm -rf public/ - -$ hugo --verbose -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -INFO: {date} {source} using a UnionFS for static directory comprised of: -INFO: {date} {source} Base: /tmp/mySite/themes/zafta/static -INFO: {date} {source} Overlay: /tmp/mySite/static/ -INFO: {date} {source} syncing static files to /tmp/mySite/public/ -Started building site -INFO: {date} {source} found taxonomies: map[string]string{"tag":"tags", "category":"categories"} -WARN: {date} {source} "article" is rendered empty -WARN: {date} {source} "article/Second.html" is rendered empty -WARN: {date} {source} "article/First.html" is rendered empty -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -2 pages created -0 non-page files copied -0 paginator pages created -0 tags created -0 categories created -in 7 ms - -$ find public -type f -name '*.html' | xargs ls -l --rw-r--r-- 1 {user} {group} 0 {date} public/404.html --rw-r--r-- 1 {user} {group} 0 {date} public/article/First/index.html --rw-r--r-- 1 {user} {group} 0 {date} public/article/index.html --rw-r--r-- 1 {user} {group} 0 {date} public/article/Second/index.html --rw-r--r-- 1 {user} {group} 232 {date} public/index.html - -$ cat public/index.html -<!DOCTYPE html> -<html> -<body> - <h4><a href="http://example.org/article/Second/">Second</a></h4> - <h4><a href="http://example.org/article/First/">First</a></h4> -</body> -</html> -``` -### All Done - -Congratulations! Your home page shows the titles of your two articles, along -with the links to them. The articles themselves are still empty. But, -let's take a moment to appreciate what we've done, so far! - -Your home page template (`layouts/index.html`) now renders output dynamically. -Believe it or not, by inserting the range command inside those doubled -curly braces, you've learned everything you need to know — -essentially — about developing a theme. - -All that's left is understanding which of your templates renders each content -file, and becoming more familiar with the commands for the template engine. -## More - -Well — if things were so simple, this tutorial would be much shorter! - -Some things are still useful to learn, because they'll make creating new -templates _much_ easier — so, I'll cover them, now. -### Base URL - -While developing and testing your theme, did you notice that the links in the -rendered `./public/index.html` file use the full "baseURL" from your -`./config.toml` file? That's because those files are intended to be deployed -to your web server. - -Whenever you test your theme, you start Hugo in web server mode -(with `hugo server`) and connect to it with your web browser. -That command is smart enough to replace the "baseURL" with -`http://localhost:1313` on the fly, so that the links automatically -work for you. - -That's another reason why we recommend testing with the built-in web server. -### Content - -The articles you've been working with are in your `./content/article/` -directory. That means their _Section_ (as far as templates are concerned) -is "article". Unless we do something unusual in their front-matter, their -_Type_ is also "article". -#### Search - -Hugo uses the Section and Type to find a template file for every piece of -content it renders. Hugo first will seek a template file in subdirectories of -`layouts/` that match its Section or Type name (i.e., in `layouts/SECTION/` -or `layouts/TYPE/`). If it can't find a file there, then it will look in the -`layouts/_default/` directory. Other documentation covers some twists about -categories and tags, but we won't use those in this tutorial. Therefore, -we can assume that Hugo will try first `layouts/article/single.html`, then -`layouts/_default/single.html`. - -Now that we know the search rule, let's see what's available: -```bash -$ find themes/zafta -name single.html | xargs ls -l --rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/_default/single.html -``` -If you look back at the articles Hugo has rendered, you can see that -they were empty. Now we can see that this is because Hugo sought -`layouts/article/single.html` but couldn't find it, and template -`layouts/_default/single.html` was empty. Therefore, the rendered article -file was empty, too. - -So, we could either create a new template, `layouts/article/single.html`, -or edit the default one. -#### Default Single - -Since we know of no other content Types, let's start by editing the default -template file, `layouts/_default/single.html`. - -As we mentioned earlier, you always should edit (or create) the most -specific template first, in order to avoid accidentally changing how other -content is displayed. However, we're breaking that rule intentionally, -just so we can explore how the default is used. - -Remember, any content — for which we don't create a specific template -— will end up using this default template. That can be good or bad. -Bad, because I know we'll be adding different Types of content, and we'll -eventually undo some of the changes we've made. Good, because then we'll be -able to see some results immediately. It's also good to create the default -template first, because with it, we can start to develop the basic layout -for the web site. - -As we add more content Types, we'll refactor this file and move its logic -around. Hugo makes this fairly painless, so we'll accept the cost and proceed. - -Please see Hugo's documentation on template rendering, for all the details on -determining which template to use. And, as the documentation mentions, if -your web site is a single-page application (SPA), you can delete all the -other templates and work with just the default Single one. By itself, -that fact provides a refreshing amount of joy. - -Let's edit the default template file (`layouts/_default/single.html`): -```html -$ vi themes/zafta/layouts/_default/single.html -<!DOCTYPE html> -<html> -<head> - <title>{{ .Title }}</title> -</head> -<body> - <h1>{{ .Title }}</h1> - <h6>{{ .Date.Format "Mon, Jan 2, 2006" }}</h6> - {{ .Content }} - <h4><a href="{{ .Site.BaseURL }}">Home</a></h4> -</body> -</html> -:wq -``` -#### Verify - -Let's render the web site, and verify the results: -```bash -$ rm -rf public/ - -$ hugo --verbose -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -INFO: {date} {source} using a UnionFS for static directory comprised of: -INFO: {date} {source} Base: /tmp/mySite/themes/zafta/static -INFO: {date} {source} Overlay: /tmp/mySite/static/ -INFO: {date} {source} syncing static files to /tmp/mySite/public/ -Started building site -INFO: {date} {source} found taxonomies: map[string]string{"tag":"tags", "category":"categories"} -WARN: {date} {source} "article" is rendered empty -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -2 pages created -0 non-page files copied -0 paginator pages created -0 tags created -0 categories created -in 7 ms - -$ find public -type f -name '*.html' | xargs ls -l --rw-r--r-- 1 {user} {group} 0 {date} public/404.html --rw-r--r-- 1 {user} {group} 473 {date} public/article/First/index.html --rw-r--r-- 1 {user} {group} 0 {date} public/article/index.html --rw-r--r-- 1 {user} {group} 514 {date} public/article/Second/index.html --rw-r--r-- 1 {user} {group} 232 {date} public/index.html -``` -Note that although Hugo rendered a file, to list your articles: -`./public/article/index.html`, the file is empty, because we don't have -a template for it. (However: see next.) The other HTML files contain your -content, as we can see below: -```html -$ cat public/article/First/index.html -<!DOCTYPE html> -<html> -<head> - <title>First</title> -</head> -<body> - <h1>First</h1> - <h6>Wed, Jan 18, 2040</h6> - <p>In vel ligula tortor. Aliquam erat volutpat. -Pellentesque at felis eu quam tincidunt dignissim. -Nulla facilisi.</p> - -<p>Pellentesque tempus nisi et interdum convallis. -In quam ante, vulputate at massa et, rutrum -gravida dui. Phasellus tristique libero at ex.</p> - - <h4><a href="http://example.org/">Home</a></h4> -</body> -</html> - -$ cat public/article/Second/index.html -<!DOCTYPE html> -<html> -<head> - <title>Second</title> -</head> -<body> - <h1>Second</h1> - <h6>Wed, Jan 18, 2040</h6> - <p>Fusce lacus magna, maximus nec sapien eu, -porta efficitur neque. Aliquam erat volutpat. -Vestibulum enim nibh, posuere eu diam nec, -varius sagittis turpis.</p> - -<p>Praesent quis sapien egestas mauris accumsan -pulvinar. Ut mattis gravida venenatis. Vivamus -lobortis risus id nisi rutrum, at iaculis.</p> - - <h4><a href="http://example.org/">Home</a></h4> -</body> -</html> -``` -Again, notice that your rendered article files have content. -You can run `hugo server` and use your browser to confirm this. -You should see your home page, and it should contain the titles of both -articles. Each title should be a link to its respective article. - -Each article should be displayed fully on its own page. And at the bottom of -each article, you should see a link which takes you back to your home page. -### Article List - -Your home page still lists your most recent articles. However — -remember, from above, that I mentioned an empty file, -`./public/article/index.html`? -Let's make that show a list of ***all*** of your articles -(not just the latest ten). - -We need to decide which template to edit. Key to this, is that -individual pages always come from Single templates. On the other hand, -only List templates are capable of rendering pages which display collections -(or lists) of other pages. - -Because the new page will show a listing, we should select a List template. -Let's take a quick look to see which List templates are available already: -```bash -$ find themes/zafta -name list.html | xargs ls -l --rw-r--r-- 1 {user} {group} 0 {date} themes/zafta/layouts/_default/list.html -``` -So, just as before with the single articles, so again now with the list of -articles, we must decide: whether to edit `layouts/_default/list.html`, -or to create `layouts/article/list.html`. -#### Default List - -We still don't have multiple content Types — so, remaining consistent, -let's edit the default List template: -```html -$ vi themes/zafta/layouts/_default/list.html -<!DOCTYPE html> -<html> -<body> - <h1>Articles</h1> - {{- range first 10 .Data.Pages }} - <h4><a href="{{ .Permalink }}">{{ .Title }}</a></h4> - {{- end }} - <h4><a href="{{ .Site.BaseURL }}">Home</a></h4> -</body> -</html> -:wq -``` -Let's render everything again: -```bash -$ rm -rf public/ - -$ hugo --verbose -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -INFO: {date} {source} using a UnionFS for static directory comprised of: -INFO: {date} {source} Base: /tmp/mySite/themes/zafta/static -INFO: {date} {source} Overlay: /tmp/mySite/static/ -INFO: {date} {source} syncing static files to /tmp/mySite/public/ -Started building site -INFO: {date} {source} found taxonomies: map[string]string{"tag":"tags", "category":"categories"} -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -2 pages created -0 non-page files copied -0 paginator pages created -0 categories created -0 tags created -in 7 ms - -$ find public -type f -name '*.html' | xargs ls -l --rw-r--r-- 1 {user} {group} 0 {date} public/404.html --rw-r--r-- 1 {user} {group} 473 {date} public/article/First/index.html --rw-r--r-- 1 {user} {group} 327 {date} public/article/index.html --rw-r--r-- 1 {user} {group} 514 {date} public/article/Second/index.html --rw-r--r-- 1 {user} {group} 232 {date} public/index.html -``` -Now (as you can see), we have a list of articles. To confirm it, -type `hugo server`; then, in your browser, navigate to `/article/`. -(Later, we'll link to it.) -## About - -Let's add an About page, and try to display it at the top level -(as opposed to the next level down, where we placed your articles). -### Guide - -Hugo's default goal is to let the directory structure of the `./content/` -tree guide the location of the HTML it renders to the `./public/` tree. -Let's check this, by generating an About page at the content's top level: -```toml -$ hugo new About.md -/tmp/mySite/content/About.md created - -$ ls -l content/ -total 8 --rw-r--r-- 1 {user} {group} 61 {date} About.md -drwxr-xr-x 4 {user} {group} 136 {date} article - -$ vi content/About.md -+++ -date = "2040-01-18T22:01:00-06:00" -title = "About" - -+++ -Neque porro quisquam est qui dolorem -ipsum quia dolor sit amet consectetur -adipisci velit. -:wq -``` -### Check - -Let's render your web site, and check the results: -```html -$ rm -rf public/ - -$ hugo --verbose -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -INFO: {date} {source} using a UnionFS for static directory comprised of: -INFO: {date} {source} Base: /tmp/mySite/themes/zafta/static -INFO: {date} {source} Overlay: /tmp/mySite/static/ -INFO: {date} {source} syncing static files to /tmp/mySite/public/ -Started building site -INFO: {date} {source} found taxonomies: map[string]string{"tag":"tags", "category":"categories"} -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -3 pages created -0 non-page files copied -0 paginator pages created -0 tags created -0 categories created -in 9 ms - -$ ls -l public/ -total 24 --rw-r--r-- 1 {user} {group} 0 {date} 404.html -drwxr-xr-x 3 {user} {group} 102 {date} About -drwxr-xr-x 6 {user} {group} 204 {date} article -drwxr-xr-x 2 {user} {group} 68 {date} css --rw-r--r-- 1 {user} {group} 316 {date} index.html --rw-r--r-- 1 {user} {group} 2221 {date} index.xml -drwxr-xr-x 2 {user} {group} 68 {date} js --rw-r--r-- 1 {user} {group} 681 {date} sitemap.xml - -$ ls -l public/About/ -total 8 --rw-r--r-- 1 {user} {group} 305 {date} index.html - -$ cat public/About/index.html -<!DOCTYPE html> -<html> -<head> - <title>About</title> -</head> -<body> - <h1>About</h1> - <h6>Wed, Jan 18, 2040</h6> - <p>Neque porro quisquam est qui dolorem -ipsum quia dolor sit amet consectetur -adipisci velit.</p> - - <h4><a href="http://example.org/">Home</a></h4> -</body> -</html> -``` -Oh, well. — Did you notice that your page wasn't rendered at the -top level? It was rendered to a subdirectory named `./public/About/`. -That name came from the basename of your Markdown file `./content/About.md`. -Interesting — but, we'll let that go, for now. -### Home - -One other thing — let's take a look at your home page: -```html -$ cat public/index.html -<!DOCTYPE html> -<html> -<body> - <h4><a href="http://example.org/About/">About</a></h4> - <h4><a href="http://example.org/article/Second/">Second</a></h4> - <h4><a href="http://example.org/article/First/">First</a></h4> -</body> -</html> -``` -Did you notice that the About link is listed with your articles? -That's not exactly where we want it; so, let's edit your home page template -(`layouts/index.html`): -```html -$ vi themes/zafta/layouts/index.html -<!DOCTYPE html> -<html> -<body> - <h2>Articles</h2> - {{- range first 10 .Data.Pages -}} - {{- if eq .Type "article"}} - <h4><a href="{{ .Permalink }}">{{ .Title }}</a></h4> - {{- end -}} - {{- end }} - <h2>Pages</h2> - {{- range first 10 .Data.Pages -}} - {{- if eq .Type "page" }} - <h4><a href="{{ .Permalink }}">{{ .Title }}</a></h4> - {{- end -}} - {{- end }} -</body> -</html> -:wq -``` -Let's render your web site, and verify the results: -```html -$ rm -rf public/ - -$ hugo --verbose -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -INFO: {date} {source} using a UnionFS for static directory comprised of: -INFO: {date} {source} Base: /tmp/mySite/themes/zafta/static -INFO: {date} {source} Overlay: /tmp/mySite/static/ -INFO: {date} {source} syncing static files to /tmp/mySite/public/ -Started building site -INFO: {date} {source} found taxonomies: map[string]string{"tag":"tags", "category":"categories"} -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -3 pages created -0 non-page files copied -0 paginator pages created -0 tags created -0 categories created -in 9 ms - -$ cat public/index.html -<!DOCTYPE html> -<html> -<body> - <h2>Articles</h2> - <h4><a href="http://example.org/article/Second/">Second</a></h4> - <h4><a href="http://example.org/article/First/">First</a></h4> - <h2>Pages</h2> - <h4><a href="http://example.org/About/">About</a></h4> -</body> -</html> -``` -Good! This time, your home page has two Sections: "article" and "page", and -each Section contains the correct set of headings and links. -## Template Sharing - -If you've been following along on your computer, you might've noticed that -your home page doesn't show its title in your browser, although both of your -article pages do. That's because we didn't add your home page's title to its -template (`layouts/index.html`). That would be easy to do — but instead, -let's look at a better option. - -We can put the common information into a shared template. -These reside in the `layouts/partials/` directory. -### Header & Footer - -In Hugo (as elsewhere), a Partial is a template that's intended to be used -within other templates. We're going to create a Partial template that will -contain a header, for all of your page templates to use. That Partial will -enable us to maintain the header information in a single place, thus easing -our maintenance. Let's create both the header (`layouts/partials/header.html`) -and the footer (`layouts/partials/footer.html`): -```html -$ vi themes/zafta/layouts/partials/header.html -<!DOCTYPE html> -<html> -<head> - <title>{{ .Title }}</title> -</head> -<body> -:wq - -$ vi themes/zafta/layouts/partials/footer.html - <h4><a href="{{ .Site.BaseURL }}">Home</a></h4> -</body> -</html> -:wq -``` -### Calling - -Any `partial` is called relative to its conventional location -`layouts/partials/`. So, you pass just the basename, followed by the context -(the period before the closing mustache). For example: -```bash -{{ partial "header.html" . }} -``` -#### From Home - -Let's change your home page template (`layouts/index.html`) -in order to use the new header Partial we just created: -```html -$ vi themes/zafta/layouts/index.html -{{ partial "header.html" . }} - <h2>Articles</h2> - {{- range first 10 .Data.Pages -}} - {{- if eq .Type "article"}} - <h4><a href="{{ .Permalink }}">{{ .Title }}</a></h4> - {{- end -}} - {{- end }} - <h2>Pages</h2> - {{- range first 10 .Data.Pages -}} - {{- if eq .Type "page" }} - <h4><a href="{{ .Permalink }}">{{ .Title }}</a></h4> - {{- end -}} - {{- end }} -</body> -</html> -:wq -``` -Render your web site and verify the results. Now, the title on your home page -should be "My New Hugo Site". This comes from the "title" variable -in the `./config.toml` file. -#### From Default - -Let's also edit the default templates (`layouts/_default/single.html` and -`layouts/_default/list.html`) to use your new Partials: -```html -$ vi themes/zafta/layouts/_default/single.html -{{ partial "header.html" . }} - <h1>{{ .Title }}</h1> - <h6>{{ .Date.Format "Mon, Jan 2, 2006" }}</h6> - {{ .Content }} -{{ partial "footer.html" . -}} -:wq - -$ vi themes/zafta/layouts/_default/list.html -{{ partial "header.html" . -}} - <h1>Articles</h1> - {{- range first 10 .Data.Pages }} - <h4><a href="{{ .Permalink }}">{{ .Title }}</a></h4> - {{- end }} -{{ partial "footer.html" . -}} -:wq -``` -Render your web site and verify the results. -Now, the title of your About page should reflect the value of the "title" -variable in its corresponding Markdown file (`./content/About.md`). -The same should be true for each of your article pages as well (i.e., -`./content/article/First.md` and `./content/article/Second.md`). -### DRY - -Don't Repeat Yourself (also known as DRY) is a desirable goal, -in any kind of source code development — -and Hugo's partials do a fine job to help with that. - -Part of the art of good templates is knowing when to add new ones, and when -to edit existing ones. While you're still figuring out the art of templates, -you should accept that you'll do some refactoring — Hugo makes this -easy and fast. And it's okay to delay splitting your templates into Partials. -## Section -### Date - -Articles commonly display the date they were published -(or finalized) — so, here, let's do the same. - -The front-matter of your articles contains a "date" variable -(as discussed above). Hugo sets this, when it creates each content file. -Now, sometimes an article requires many days to prepare, so its actual -publishing date might be later than the front-matter's "date". However, for -simplicity's sake, let's pretend this is the date we want to display, each time. - -In Hugo, in order to format a variable date (or time), -we must do it by formatting the Go language [reference -time](https://golang.org/pkg/time/); for example: -```bash -{{ .Date.Format "Mon, Jan 2, 2006" }} -``` -Now, your articles use the `layouts/_default/single.html` template (see above). -Because that template includes a date-formatting snippet, they show a -nice looking date. However, your About page uses the same default template. -Unfortunately, now it too shows its creation date (which makes no sense)! - -There are a couple of ways to make the date display only for articles. -We could use an "if" statement, to display the date only when the Type equals -"article." That is workable, and acceptable for web sites with only a couple -of content Types. It aligns with the principle of "code for today," too. -### Template - -Let's assume, though (for didactic purposes), that you've made your web site so -complex that you feel you must create a new template Type. In Hugo-speak, this -will be a new Section. It will contain your new, "article" Single template. - -Let's restore your default Single template (`layouts/_default/single.html`) -to its earlier state (before we forget): -```html -$ vi themes/zafta/layouts/_default/single.html -{{ partial "header.html" . }} - <h1>{{ .Title }}</h1> - {{ .Content }} -{{ partial "footer.html" . -}} -:wq -``` -Now, let's create your new template. If you remember Hugo's rules, -the template engine will prefer this version over the default. The first step -is to create (within your theme) its Section's directory: `layouts/article/`. -Then, create a Single template (`layouts/article/single.html`) within it: -```html -$ mkdir themes/zafta/layouts/article - -$ vi themes/zafta/layouts/article/single.html -{{ partial "header.html" . }} - <h1>{{ .Title }}</h1> - <h6>{{ .Date.Format "Mon, Jan 2, 2006" }}</h6> - {{ .Content }} -{{ partial "footer.html" . -}} -:wq -``` -Basically, we moved the date logic — from the default template, to the -new "article" Section, Single template: `layouts/article/single.html`. - -Let's render your web site and verify the results: -```html -$ rm -rf public/ - -$ hugo --verbose -INFO: {date} {source} Using config file: /tmp/mySite/config.toml -INFO: {date} {source} using a UnionFS for static directory comprised of: -INFO: {date} {source} Base: /tmp/mySite/themes/zafta/static -INFO: {date} {source} Overlay: /tmp/mySite/static/ -INFO: {date} {source} syncing static files to /tmp/mySite/public/ -Started building site -INFO: {date} {source} found taxonomies: map[string]string{"tag":"tags", "category":"categories"} -WARN: {date} {source} "404.html" is rendered empty -0 draft content -0 future content -0 expired content -3 pages created -0 non-page files copied -0 paginator pages created -0 tags created -0 categories created -in 10 ms - -$ cat public/article/First/index.html -<!DOCTYPE html> -<html> -<head> - <title>First</title> -</head> -<body> - - <h1>First</h1> - <h6>Wed, Jan 18, 2040</h6> - <p>In vel ligula tortor. Aliquam erat volutpat. -Pellentesque at felis eu quam tincidunt dignissim. -Nulla facilisi.</p> - -<p>Pellentesque tempus nisi et interdum convallis. -In quam ante, vulputate at massa et, rutrum -gravida dui. Phasellus tristique libero at ex.</p> - - <h4><a href="http://example.org/">Home</a></h4> -</body> -</html> - -$ cat public/About/index.html -<!DOCTYPE html> -<html> -<head> - <title>About</title> -</head> -<body> - - <h1>About</h1> - <p>Neque porro quisquam est qui dolorem -ipsum quia dolor sit amet consectetur -adipisci velit.</p> - - <h4><a href="http://example.org/">Home</a></h4> -</body> -</html> -``` -Now, as you can see, your articles show their dates, -and your About page (sensibly) doesn't. diff --git a/docs/content/tutorials/deployment-with-rsync.md b/docs/content/tutorials/deployment-with-rsync.md deleted file mode 100644 index 7bc516650..000000000 --- a/docs/content/tutorials/deployment-with-rsync.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -authors: -- Adrien Poupin -date: 2016-11-01 -linktitle: Deployment with rsync -toc: true -menu: - main: - parent: tutorials -next: /tutorials/creating-a-new-theme -prev: /tutorials/automated-deployments -title: Easy deployments with rsync -weight: 11 - ---- - -# How to build and deploy with hugo and rsync -We assume here that you have an access to your web host with SSH. In that case, as you will see, deployment is very simple. We also assume that you have a functional static site with hugo installed. - -The spoil is, you can deploy your entire site with a command that looks like this: - -```bash -hugo && rsync -avz --delete public/ www-data@ftp.topologix.fr:~/www/ -``` - -As you will see, we put it in a shell script file, which makes building and deployment as easy as executing `./deploy`. - -## Installing SSH Key - -If it is not done yet, we will make an automated way to SSH to your server. If you have already installed an SSH key, switch to the next section. - -First, install the ssh client. On Debian/Ubuntu/derivates, enter `sudo apt-get install openssh-client`. - -Then generate your ssh key by entering the following commands: -``` -~$ cd && mkdir .ssh & cd .ssh -~/.ssh/$ ssh-keygen -t rsa -q -C "For SSH" -f rsa_id -~/.ssh/$ cat >> config <<EOF -Host HOST - Hostname HOST - Port 22 - User USER - IdentityFile ~/.ssh/rsa_id -EOF -``` -Don't forget to replace the `HOST` and `USER` values with your own ones. Then copy your ssh public key to the remote server: - -``` -~/.ssh/$ ssh-copy-id -i rsa_id.pub USER@HOST.com -``` - -Now you can easily connect to the remote server: - -``` -~$ ssh user@host -Enter passphrase for key '/home/mylogin/.ssh/rsa_id': -``` - -And you've done it! - -## Shell script - -We will put the first command in a script at the root of your hugo tree: - -``` -~/websites/topologix.fr$ editor deploy -``` -Here you put the following content. Replace the `USER`, `HOST` and `DIR` values with your own. - -``` -#!/bin/sh -USER=my-user -HOST=my-server.com -DIR=my/directory/to/topologix.fr/ # might sometimes be empty! - -hugo && rsync -avz --delete public/ ${USER}@${HOST}:~/${DIR} - -exit 0 -``` - -Note that `DIR` is the relative path from the remote user's home. If you have to specify a full path (for instance `/var/www/mysite/`) you must change `~/${DIR}` to `${DIR}` inside the command line. For most cases you should not have to. - -Save and close, and make the `deploy` file executable: - -``` -~/websites/topologix.fr$ chmod +x deploy -``` - -Now you only have to enter the following command to deploy and update your website: - -``` -~/websites/topologix.fr$ ./deploy -Started building sites ... -Built site for language en: -0 draft content -0 future content -0 expired content -5 pages created -0 non-page files copied -0 paginator pages created -0 tags created -0 categories created -total in 56 ms -sending incremental file list -404.html -index.html -index.xml -sitemap.xml -cours-versailles/index.html -exercices/index.html -exercices/index.xml -exercices/barycentre-et-carres-des-distances/index.html -post/ -post/index.html -sujets/index.html -sujets/index.xml -sujets/2016-09_supelec-jp/index.html -tarifs-contact/index.html - -sent 9,550 bytes received 1,708 bytes 7,505.33 bytes/sec -total size is 966,557 speedup is 85.86 -``` - -And it's done! - diff --git a/docs/content/tutorials/github-pages-blog.md b/docs/content/tutorials/github-pages-blog.md deleted file mode 100644 index 013642ded..000000000 --- a/docs/content/tutorials/github-pages-blog.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -aliases: - - /tutorials/github_pages_blog/ -author: Spencer Lyon, Gunnar Morling -lastmod: 2017-01-11 -date: 2014-03-21 -linktitle: Hosting on GitHub -toc: true -menu: - main: - parent: tutorials -next: /tutorials/how-to-contribute-to-hugo/ -prev: /tutorials/creating-a-new-theme -title: Hosting on GitHub Pages -weight: 10 ---- - -*This tutorial was contributed by [Spencer Lyon](http://spencerlyon.com/) (Personal/Organization Pages) and [Gunnar Morling](https://github.com/gunnarmorling/).* - -## Introduction - -This tutorial describes how to deploy your Hugo based website to [GitHub pages](https://pages.github.com/). - -The following sections are based on the assumption that you are working with a "Project Pages Site". -This means that you'll have your Hugo sources and the generated HTML output within a single repository -(in contrast, with a "User/Organization Pages Site", you'd have one repo for the sources and another repo for the published HTML files; -refer to the [GitHub Pages docs](https://help.github.com/articles/user-organization-and-project-pages/) to learn more). - -## Deployment via _/docs_ folder on master branch - -[As described](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/#publishing-your-github-pages-site-from-a-docs-folder-on-your-master-branch) in the GitHub Pages docs, you can deploy from a folder called _docs_ on your master branch. -This requires to change the Hugo publish directory in the site config (e.g. _config.toml_): - - publishDir = "docs" - -After running `hugo`, push your master branch to the remote repo and choose the _docs_ folder as the website source of your repo -(in your GitHub project, go to "Settings " -> "GitHub Pages" -> "Source" -> Select "master branch /docs folder"). -If that option isn't enabled, you likely haven't pushed your _docs_ folder yet. - -This is the simplest approach but requires the usage of a non-standard publish directory -(GitHub Pages cannot be configured to use another directory than _docs_ currently). -Also the presence of generated files on the master branch may not be to everyone's taste. - -## Deployment via gh-pages branch - -Alternatively, you can deploy site through a separate branch called "gh_pages". -That approach is a bit more complex but has some advantages: - -* It keeps sources and generated HTML in two different branches -* It uses the default _public_ folder -* It keeps the histories of source branch and gh-pages branch fully separated from each other - -### Preparations - -These steps only need to be done once (replace "upstream" with the name of your remote, e.g. "origin"): -First, add the _public_ folder to _.gitignore_ so it's ignored on the master branch: - - echo "public" >> .gitignore - -Then initialize the gh-pages branch as an empty [orphan branch](https://git-scm.com/docs/git-checkout/#git-checkout---orphanltnewbranchgt): - - git checkout --orphan gh-pages - git reset --hard - git commit --allow-empty -m "Initializing gh-pages branch" - git push upstream gh-pages - git checkout master - -### Building and Deployment - -Now check out the gh-pages branch into your _public_ folder, using git's [worktree feature](https://git-scm.com/docs/git-worktree) -(essentially, it allows you to have multiple branches of the same local repo to be checked out in different directories): - - rm -rf public - git worktree add -B gh-pages public upstream/gh-pages - -Regenerate the site using Hugo and commit the generated files on the gh-pages branch: - - hugo - cd public && git add --all && git commit -m "Publishing to gh-pages" && cd .. - -If the changes in your local gh-pages branch look alright, push them to the remote repo: - - git push upstream gh-pages - -After a short while you'll see the updated contents on your GitHub Pages site. - -### Putting it into a script - -To automate these steps, you can create a script _scripts/publish_to_ghpages.sh_ with the following contents: - -``` -#!/bin/sh - -DIR=$(dirname "$0") - -cd $DIR/.. - -if [[ $(git status -s) ]] -then - echo "The working directory is dirty. Please commit any pending changes." - exit 1; -fi - -echo "Deleting old publication" -rm -rf public -mkdir public -git worktree prune -rm -rf .git/worktrees/public/ - -echo "Checking out gh-pages branch into public" -git worktree add -B gh-pages public upstream/gh-pages - -echo "Removing existing files" -rm -rf public/* - -echo "Generating site" -hugo - -echo "Updating gh-pages branch" -cd public && git add --all && git commit -m "Publishing to gh-pages (publish.sh)" -``` - -This will abort if there are pending changes in the working directory and also makes sure that all previously existing output files are removed. -Adjust the script to taste, e.g. to include the final push to the remote repository if you don't need to take a look at the gh-pages branch before pushing. Or adding `echo yourdomainname.com >> CNAME` if you set up for your gh-pages to use customize domain. - -## Deployment with Git 2.4 and earlier - -The `worktree` command was only introduced in Git 2.5. -If you are still on an earlier version and cannot update, you can simply clone your local repo into the _public_ directory, only keeping the gh-pages branch: - - git clone .git --branch gh-pages public - -Having re-generated the site, you'd push back the gh-pages branch to your primary local repo: - - cd public && git add --all && git commit -m "Publishing to gh-pages" && git push origin gh-pages - -The other steps are the same as with the worktree approach. - -## Hosting Personal/Organization Pages - -As mentioned [in this GitHub's article](https://help.github.com/articles/user-organization-and-project-pages/), besides project pages, you may also want to host a user/organization page. Here are the key differences: - -> - You must use the `username.github.io` naming scheme. -> - Content from the `master` branch will be used to build and publish your GitHub Pages site. - -It becomes much simpler in that case: we'll create two separate repos, one for Hugo's content, and a git submodule with the `public` folder's content in it. - -Step by step: - -1. Create on GitHub `<your-project>-hugo` repository (it will host Hugo's content) -2. Create on GitHub `<username>.github.io` repository (it will host the `public` folder: the static website) -3. `git clone <<your-project>-hugo-url> && cd <your-project>-hugo` -4. Make your website work locally (`hugo server -t <yourtheme>`) -5. Once you are happy with the results, <kbd>Ctrl</kbd>+<kbd>C</kbd> (kill server) and `rm -rf public` (don't worry, it can always be regenerated with `hugo -t <yourtheme>`) -6. `git submodule add -b master git@github.com:<username>/<username>.github.io.git public` -7. Almost done: add a `deploy.sh` script to help you (and make it executable: `chmod +x deploy.sh`): - -``` -#!/bin/bash - -echo -e "\033[0;32mDeploying updates to GitHub...\033[0m" - -# Build the project. -hugo # if using a theme, replace by `hugo -t <yourtheme>` - -# Go To Public folder -cd public -# Add changes to git. -git add -A - -# Commit changes. -msg="rebuilding site `date`" -if [ $# -eq 1 ] - then msg="$1" -fi -git commit -m "$msg" - -# Push source and build repos. -git push origin master - -# Come Back -cd .. -``` -7. `./deploy.sh "Your optional commit message"` to send changes to `<username>.github.io` (careful, you may also want to commit changes on the `<your-project>-hugo` repo). - -That's it! Your personal page is running at [http://username.github.io/](http://username.github.io/) (after up to 10 minutes delay). - -## Using a custom domain - -If you'd like to use a custom domain for your GitHub Pages site, create a file _static/CNAME_ with the domain name as its sole contents. -This will put the CNAME file to the root of the published site as required by GitHub Pages. - -Refer to the [official documentation](https://help.github.com/articles/using-a-custom-domain-with-github-pages/) for further information. - -## Conclusion - -Hopefully this tutorial helped you to get your website off its feet and out into the open! If you have any further questions, feel free to contact the community through the [discussion forum](/community/mailing-list/). diff --git a/docs/content/tutorials/hosting-on-bitbucket.md b/docs/content/tutorials/hosting-on-bitbucket.md deleted file mode 100644 index 027618fa5..000000000 --- a/docs/content/tutorials/hosting-on-bitbucket.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -authors: -- Jason Gowans -lastmod: 2017-02-04 -date: 2017-02-04 -linktitle: Hosting on Bitbucket -toc: true -menu: - main: - parent: tutorials -next: /tutorials/github-pages-blog -prev: /tutorials/creating-a-new-theme -title: Continuous deployment with Bitbucket & Aerobatic -weight: 10 ---- - -# Continuous deployment with Bitbucket & Aerobatic - -## Introduction - -In this tutorial, we will use [Bitbucket](https://bitbucket.org/) and [Aerobatic](https://www.aerobatic.com) to build, deploy, and host a Hugo site. Aerobatic is a static hosting service that integrates with Bitbucket and provides a free hosting tier. - -It is assumed that you know how to use git for version control and have a Bitbucket account. - -## Install Aerobatic CLI - -If you haven't previously used Aerobatic, you'll first need to install the Command Line Interface (CLI) and create an account. For a list of all commands available, see the [Aerobatic CLI](https://www.aerobatic.com/docs/cli/) docs. - -```bash -npm install aerobatic-cli -g -aero register -``` - -## Create and Deploy Site - -```bash -hugo new site my-new-hugo-site -cd my-new-hugo-site -cd themes; git clone https://github.com/eliasson/liquorice -hugo -t liquorice -aero create # create the Aerobatic site -hugo --baseURL https://my-new-hugo-site.aerobatic.io # build the site overriding baseURL -aero deploy -d public # deploy output to Aerobatic - -Version v1 deployment complete. -View now at https://hugo-docs-test.aerobatic.io -``` - -In the rendered page response, the `https://__baseurl__` will be replaced with your actual site url (in this example, `https://my-new-hugo-site.aerobatic.io`). You can always rename your Aerobatic website with the `aero rename` command. - -## Push Hugo site to Bitbucket - -We will now create a git repository and then push our code to Bitbucket. In Bitbucket, create a repository. - -![][1] - -[1]: /img/tutorials/hosting-on-bitbucket/bitbucket-create-repo.png - - -```bash -# initialize new git repository -git init - -# set up our .gitignore file -echo -e "/public \n/themes \naero-deploy.tar.gz" >> .gitignore - -# commit and push code to master branch -git add --all -git commit -m "Initial commit" -git remote add origin git@bitbucket.org:YourUsername/my-new-hugo-site.git -git push -u origin master -``` - -## Continuous Deployment With Bitbucket Pipelines -In the example above, we pushed the compiled assets in the `/public` folder to Aerobatic. In the following example, we use Bitbucket Pipelines to continuously create and deploy the compiled assets to Aerobatic. - -### Step 1: Configure Bitbucket Pipelines - -In your Hugo website's Bitbucket repo; - -1. Click the Pipelines link in the left nav menu of your Bitbucket repository. -2. Click the Enable Pipelines button. -3. On the next screen, leave the default template and click Next. -4. In the editor, paste in the yaml contents below and click Commit. - -```bash -image: beevelop/nodejs-python -pipelines: - branches: - master: - - step: - script: - - apt-get update -y && apt-get install wget - - apt-get -y install git - - wget https://github.com/gohugoio/hugo/releases/download/v0.18/hugo_0.18-64bit.deb - - dpkg -i hugo*.deb - - git clone https://github.com/eliasson/liquorice themes/liquorice - - hugo --theme=liquorice --baseURL https://__baseurl__ --buildDrafts - - npm install -g aerobatic-cli - - aero deploy -``` - -### Step 2: Create `AEROBATIC_API_KEY` environment variable. - -This step only needs to be done once per account. From the command line; - -```bash -aero apikey -``` - -1. Navigate to the Bitbucket account settings for the account that the website repo belongs to. -2. Scroll down to the bottom of the left nav and click the Environment variables link in the PIPELINES section. -3. Create a new environment variable called AEROBATIC_API_KEY with the value you got by running the `aero apikey` command. Be sure to click the Secured checkbox. - -## Step 3: Edit and Commit Code - -```bash -hugo new post/good-to-great.md -hugo server --buildDrafts -t liquorice #Check that all looks good - -# commit and push code to master branch -git add --all -git commit -m "New blog post" -git push -u origin master -``` - -Your code will be committed to Bitbucket, Bitbucket Pipelines will run your build, and a new version of your site will be deployed to Aerobatic. - -At this point, you can now create and edit blog posts directly in the Bitbucket UI. - -![][2] - -[2]: /img/tutorials/hosting-on-bitbucket/bitbucket-blog-post.png - - -## Suggested next steps - -The code for this example can be found in this Bitbucket [repository](https://bitbucket.org/dundonian/hugo-docs-test). Aerobatic also provides a number of additional [plugins](https://www.aerobatic.com/docs) such as auth and redirects that you can use for your Hugo site. diff --git a/docs/content/tutorials/hosting-on-gitlab.md b/docs/content/tutorials/hosting-on-gitlab.md deleted file mode 100644 index 0c213d1ee..000000000 --- a/docs/content/tutorials/hosting-on-gitlab.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -author: Riku-Pekka Silvola -lastmod: 2016-06-23 -date: 2016-06-23 -linktitle: Hosting on GitLab -toc: true -menu: - main: - parent: tutorials -next: /tutorials/how-to-contribute-to-hugo/ -prev: /tutorials/github-pages-blog -title: Hosting on GitLab Pages -weight: 10 ---- -# Continuous deployment with GitLab - -## Introduction - -In this tutorial, we will use [GitLab](https://gitlab.com/) to build, deploy, and host a [Hugo](https://gohugo.io/) site. With Hugo and GitLab, this is incredibly easy. - -It is assumed that you know how to use git for version control and have a GitLab account, and that you have gone through the [quickstart guide]({{< relref "overview/quickstart.md" >}}) and already have a Hugo site on your local machine. - - -## Create .gitlab-ci.yml - -```bash -cd your-hugo-site -``` - -In the root directory of your Hugo site, create a `.gitlab-ci.yml` file. The `.gitlab-ci.yml` configures the GitLab CI on how to build your page. Simply add the content below. - -```yml -image: publysher/hugo - -pages: - script: - - hugo - artifacts: - paths: - - public - only: - - master -``` - -## Push Hugo site to GitLab -Next up, create a new repository on GitLab. It is *not* necessary to set the repository public. In addition, you might want to add `/public` to your .gitignore file, as there is no need to push compiled assets to GitLab. - -```bash -# initialize new git repository -git init - -# add /public directory to our .gitignore file -echo "/public" >> .gitignore - -# commit and push code to master branch -git add . -git commit -m "Initial commit" -git remote add origin https://gitlab.com/YourUsername/your-hugo-site.git -git push -u origin master -``` - -## Wait for your page to be built -That's it! You can now follow the CI agent building your page at https://gitlab.com/YourUsername/your-hugo-site/pipelines. -After the build has passed, your new website is available at https://YourUsername.gitlab.io/your-hugo-site/ - -## Suggested next steps - -GitLab supports using custom CNAME's and TLS certificates, but this is out of the scope of this tutorial. For more details on GitLab Pages, see [https://about.gitlab.com/2016/04/07/gitlab-pages-setup/](https://about.gitlab.com/2016/04/07/gitlab-pages-setup/) diff --git a/docs/content/tutorials/how-to-contribute-to-hugo.md b/docs/content/tutorials/how-to-contribute-to-hugo.md deleted file mode 100644 index 7bfa62c53..000000000 --- a/docs/content/tutorials/how-to-contribute-to-hugo.md +++ /dev/null @@ -1,352 +0,0 @@ ---- -date: 2016-04-03T13:21:56+02:00 -linktitle: How to contribute -menu: - main: - parent: tutorials -next: /tutorials/installing-on-mac/ -prev: /tutorials/github-pages-blog/ -title: How to contribute to Hugo -weight: 10 ---- - -## Introduction - -Hugo is an open source project and lives by the work of its [contributors](https://github.com/gohugoio/hugo/graphs/contributors). Help to make Hugo even more awesome. There are plenty of [open issues](https://github.com/gohugoio/hugo/issues) on GitHub and we need your help. - -This tutorial is intended for people who are new to Git, GitHub or open source projects in general. It should help to overcome most of the barriers that newcomers encounter. It describes step by step what you need to do. - -For any kind of questions please take a look at our [forum](https://discuss.gohugo.io/). - -## Install Go - -The installation of Go should take only a few minutes. [Download](https://golang.org/dl/) the latest stable version of Go and follow the official [installation guide](https://golang.org/doc/install). - -Let's confirm the correct installation of Go. Open a terminal (or command line under Windows). Execute `go version` and you should see the version number of your Go installation. Next, make sure that you setup the `GOPATH` as described in the installation guide. - -You can print the `GOPATH` with `echo $GOPATH`. You should see a non-empty string containing a valid path to your Go workspace. - -### GVM as alternative - -More experienced users can use the [Go Version Manager](https://github.com/moovweb/gvm), or GVM for short. It allows you to switch between different Go versions *on the same machine*. Probably you don't need this feature. But you can easily upgrade to a new released Go version with a few commands. - -This is handy if you follow the developement of Hugo over a longer period of time. Future versions of Hugo will usually be compiled with the latest version of Go. Sooner or later you have to upgrade if you want to keep up. - - -## Create an account on GitHub - -If you're going to contribute code, you'll need to have an account on GitHub. Go to [www.github.com/join](https://github.com/join) and set up a personal account. - - -## Install Git on your system - -You will need to install Git. This tutorial assumes basic knowledge about Git. Refer to this excellent [Git book](https://git-scm.com/) if you are not sure where to begin. The used terminology will be explained with annotations. - -Git is a [version control system](https://en.wikipedia.org/wiki/Version_control) to track the changes of source code. Hugo depends on smaller third-party packages that are used to extend the functionality. We use them because we don't want to reinvent the wheel. - -Go ships with a sub-command called `get` that will download these packages for us when we setup our working environment. The source code of the packages is tracked with Git. `get` will interact with the Git servers of the package hosters in order to fetch all dependencies. - -Move back to the terminal and check if Git is already installed. Type in `git version` and press enter. You can skip the rest of this section if the command returned a version number. Otherwise [download](https://git-scm.com/downloads) the lastest version of Git and follow this [installation guide](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). - -Finally, check again with `git version` if Git was installed successfully. - -### Git Graphical Front Ends - -There are several [GUI clients](https://git-scm.com/downloads/guis) that help you to operate Git. Not all are available for all operating systems and maybe differ in their usage. Thus, so we will use the command line since the commands are everywhere the same. - -### Install Hub on your system (optional) - -Hub is a great tool for working with GitHub. The main site for it is [www.hub.github.com](https://hub.github.com/). Feel free to install this little Git wrapper. - -On a Mac, install Hub using brew: - -```sh -brew install hub -``` - -Create an alias (in Bash) so that typing git actually runs Hub: - -```sh -echo "alias git='hub'" >> ~/.bash_profile -``` - -Confirm the installation: - -```sh -git version 2.6.3 -hub version 2.2.2 -``` - - -## Set up your working copy - -The working copy is set up locally on your computer. It's what you'll edit, compile, and end up pushing back to GitHub. The main steps are cloning the repository and creating your fork as a remote. - -### Vendored Dependencies - -Hugo uses [govendor](https://github.com/kardianos/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 and manage Hugo's dependencies. - -```sh -go get -v -u github.com/kardianos/govendor -``` - -### Fetch the Sources from GitHub - -We assume that you've set up your `GOPATH` (see the section above if you're unsure about this). You should now copy the Hugo repository down to your computer. You'll hear this called "clone the repo". GitHub's [help pages](https://help.github.com/articles/cloning-a-repository/) give us a short explanation: - -> When you create a repository on GitHub, it exists as a remote repository. You can create a local clone of your repository on your computer and sync between the two locations. - -We're going to clone the [master Hugo repository](https://github.com/gohugoio/hugo). That seems counter-intuitive, since you won't have commit rights on it. But it's required for the Go workflow. You'll work on a copy of the master and push your changes to your own repository on GitHub. - -So, let's clone that master repository with govendor: - -```sh -govendor get -v github.com/gohugoio/hugo -``` - -### Fork the repository - -If you're not familiar with this term, GitHub's [help pages](https://help.github.com/articles/fork-a-repo/) provide again a simple explanation: - -> A fork is a copy of a repository. Forking a repository allows you to freely experiment with changes without affecting the original project. - -#### Fork by hand - -Open the [Hugo repository](https://github.com/gohugoio/hugo) on GitHub and click on the "Fork" button in the top right. - - - -Now open your fork repository on GitHub and copy the remote url of your fork. You can choose between HTTPS and SSH as protocol that Git should use for the following operations. HTTPS works always [if you're not sure](https://help.github.com/articles/which-remote-url-should-i-use/). - - - -Switch back to the terminal and move into the directory of the cloned master repository from the last step. - -```sh -cd $GOPATH/src/github.com/gohugoio/hugo -``` - -Now Git needs to know that our fork exists by adding the copied remote url: - -```sh -git remote add <YOUR-GITHUB-USERNAME> <COPIED REMOTE-URL> -``` - -#### Fork with Hub - -Alternatively, you can use the Git wrapper Hub. Hub makes forking a repository easy: - -```sh -git fork -``` - -That command will log in to GitHub using your account, create a fork of the repository that you're currently working in, and add it as a remote to your working copy. - -#### Trust, but verify - -Let's check if everything went right by listing all known remotes: - -```sh -git remote -v -``` - -The output should look similar: - -```sh -digitalcraftsman git@github.com:digitalcraftsman/hugo.git (fetch) -digitalcraftsman git@github.com:digitalcraftsman/hugo.git (push) -origin https://github.com/gohugoio/hugo (fetch) -origin https://github.com/gohugoio/hugo (push) -``` - - -## The contribution workflow - -### Create a new branch - -You should never develop against the "master" branch. The development team will not accept a pull request against that branch. Instead, create a descriptive named branch and work on it. - -First, you should always pull the latest changes from the master repository: - -```sh -git checkout master -git pull -``` - -Now we can create a new branch for your additions: - -```sh -git checkout -b <BRANCH-NAME> -``` - -You can check on which branch your are with `git branch`. You should see a list of all local branches. The current branch is indicated with a little asterisk. - -### Contributing to the documentation - -Perhaps you want to start contributing to the docs. Then you can ignore most of the following steps. You can find the documentation within the cloned repository in the subfolder `docs`. Change the directory with `cd docs`. Install the [latest release]({{< relref "overview/installing.md" >}}). Or read on and build Hugo from source. - -You can start Hugo's built-in server via `hugo server`. Browse the documentation by entering [http://localhost:1313](http://localhost:1313) in the address bar of your browser. The server automatically updates the page if you change its content. - -### Building Hugo - -While making changes in the codebase it's a good idea to build the binary to test them: - -```sh -make hugo -``` - -### Testing - -Sometimes changes on the codebase can cause unintended side effects. Or they don't work as expected. Most functions have their own test cases. You can find them in files ending with `_test.go`. - -```sh -make check -``` - -### Formatting - -The Go code styleguide maybe is opinionated but it ensures that the codebase looks the same, regardless who wrote the code. Go comes with its own formatting tool. Let's apply the styleguide to our additions: - -```sh -govendor fmt +local -``` - -Once you made your additions commit your changes. Make sure that you follow our [code contribution guidelines](https://github.com/gohugoio/hugo/blob/master/CONTRIBUTING.md): - -```sh -# Add all changed files -git add --all -git commit --message "YOUR COMMIT MESSAGE" -``` - -The commit message should describe what the commit does (e.g. add feature XYZ), not how it is done. - -### Modify commits - -You noticed some commit messages don't fulfill the code contribution guidelines or you just forget something to add some files? No problem. Git provides the necessary tools to fix such problems. The next two methods cover all common cases. - -If you are unsure what a command does leave the commit as it is. We can fix your commits later in the pull request. - -#### Modifying the last commit - -Let's say you want to modify the last commit message. Run the following command and replace the current message: - -```sh -git commit --amend -m"YOUR NEW COMMIT MESSAGE" -``` - -Take a look at the commit log to see the change: - -```sh -git log -# Exit with q -``` - -After making the last commit you may forgot something. There is no need to create a new commit. Just add the latest changes and merge them into the intended commit: - -```sh -git add --all -git commit --amend -``` - -#### Modifying multiple commits - -This is a bit more advanced. Git allows you to [rebase](https://git-scm.com/docs/git-rebase) commits interactively. In other words: it allows you to rewrite the commit history. **Take care of your actions. They can cause unintended changes. Skip this section if you're not sure!** - -```sh -git rebase --interactive @~6 -``` - -The `6` at the end of the command represents the number of commits that should be modified. An editor should open and present a list of last six commit messages: - -```sh -pick 80d02a1 tpl: Add hasPrefix to the template funcs' "smoke test" -pick aaee038 tpl: Sort the smoke tests -pick f0dbf2c tpl: Add the other test case for hasPrefix -pick 911c35b Add "How to contribute to Hugo" tutorial -pick 33c8973 Begin workflow -pick 3502f2e Refactoring and typo fixes -``` - -In the case above we should merge the last to commits in the commit of this tutorial (`Add "How to contribute to Hugo" tutorial`). You can "squash" commits, i.e. merge two or more commits into a single one. - -All operations are written before the commit message. Replace "pick" with an operation. In this case `squash` or `s` for short: - - -```sh -pick 80d02a1 tpl: Add hasPrefix to the template funcs' "smoke test" -pick aaee038 tpl: Sort the smoke tests -pick f0dbf2c tpl: Add the other test case for hasPrefix -pick 911c35b Add "How to contribute to Hugo" tutorial -squash 33c8973 Begin workflow -squash 3502f2e Refactoring and typo fixes -``` - -We also want to rewrite the commits message of the third last commit. We forgot "docs:" as prefix according to the code contribution guidelines. The operation to rewrite a commit is called `reword` (or `r` as shortcut). - -You should end up with a similar setup: - -```sh -pick 80d02a1 tpl: Add hasPrefix to the template funcs' "smoke test" -pick aaee038 tpl: Sort the smoke tests -pick f0dbf2c tpl: Add the other test case for hasPrefix -reword 911c35b Add "How to contribute to Hugo" tutorial -squash 33c8973 Begin workflow -squash 3502f2e Refactoring and typo fixes -``` - -Close the editor. It should open again with a new tab. A text is instructing you to define a new commit message for the last two commits that should be merged (a.k.a. squashed). Save the file (<kbd>CTRL</kbd>+<kbd>S</kbd>) and close the editor again. - -A last time a new tab opens. Enter a new commit message and save again. Your terminal should contain a status message. Hopefully this one: - -```sh -Successfully rebased and updated refs/heads/<BRANCHNAME>. -``` - -Check the commit log if everything looks as expected. Should an error occur you can abort this rebase with `git rebase --abort`. - -### Push commits - -To push our commits to the fork on GitHub we need to specify a destination. A destination is defined by the remote and a branch name. Earlier, the defined that the remote url of our fork is the same as our GitHub handle, in my case `digitalcraftsman`. The branch should have the same as our local one. This makes it easy to identify corresponding branches. - -```sh -git push --set-upstream <YOUR-GITHUB-USERNAME> <BRANCHNAME> -``` - -Now Git knows the destination. Next time when you to push commits you just need to enter `git push`. - -If you modified your commit history in the last step GitHub will reject your try to push. This is a safety-feature because the commit history isn't the same and new commits can't be appended as usual. You can enforce this push explicitly with `git push --force`. - - -## Open a pull request - -We made a lot of progress. Good work. In this step we finally open a pull request to submit our additions. Open the [Hugo master repository](https://github.com/gohugoio/hugo/) on GitHub in your browser. - -You should find a green button labeled with "New pull request". But GitHub is clever and probably suggests you a pull request like in the beige box below: - -<img src="/img/tutorials/how-to-contribute-to-hugo/open-pull-request.png" alt="Open a pull request"> - -The new page summaries the most important information of your pull request. Scroll down and you find the additions of all your commits. Make sure everything looks as expected and click on "Create pull request". - -### Accept the contributor license agreement - -Last but not least you should accept the contributor license agreement (CLA). A new comment should be added automatically to your pull request. Click on the yellow badge, accept the agreement and authenticate yourself with your GitHub account. It just takes a few clicks and only needs to be done once. - -<img src="/img/tutorials/how-to-contribute-to-hugo/accept-cla.png" alt="Accept the CLA"> - - -### Automatic builds - -We use the [Travis CI loop](https://travis-ci.org/gohugoio/hugo) (Linux and OS X) and [AppVeyor](https://ci.appveyor.com/project/gohugoio/hugo/branch/master) (Windows) to compile Hugo with your additions. This should ensure that everything works as expected before merging your pull request. This in most cases only relevant if you made changes to the codebase of Hugo. - -<img src="/img/tutorials/how-to-contribute-to-hugo/ci-errors.png" alt="Automic builds and their status"> - -Above you can see that Travis wasn't able to compile the changes in this pull request. Click on "Details" and try to investigate why the build failed. But it doesn't have to be your fault. Mostly, the `master` branch that we used as foundation for your pull request should build without problems. - -If you have questions leave a comment in the pull request. We are willing to assist you. - -## Where to start? - -Thank you for reading this tutorial. Hopefully, we see you again on GitHub. There are plenty of [open issues](https://github.com/gohugoio/hugo/issues) on GitHub. Feel free to open an issue if you think you found a bug or you have a new idea to improve Hugo. We are happy to hear from you. diff --git a/docs/content/tutorials/installing-on-mac.md b/docs/content/tutorials/installing-on-mac.md deleted file mode 100644 index e2b49a0da..000000000 --- a/docs/content/tutorials/installing-on-mac.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -author: "Michael Henderson" -lastmod: 2016-08-10 -date: 2015-02-22 -linktitle: Installing on Mac -toc: true -menu: - main: - parent: tutorials -next: /tutorials/installing-on-windows -prev: /tutorials/how-to-contribute-to-hugo/ -title: Installing on a Mac -weight: 10 ---- - -# Installing Hugo on a Mac - -This tutorial aims to be a complete guide to installing Hugo on your Mac computer. - -## Assumptions - -1. You know how to open a terminal window. -2. You're running a modern 64-bit Mac. -3. You will use `~/Sites` as the starting point for your site. - -## Pick Your Method - -There are three ways to install Hugo on your Mac computer: the `brew` utility, from the distribution, or from source. -There's no "best" way to do this. You should use the method that works best for your use case. - -There are pros and cons for each. - -1. `Brew` is the simplest and least work to maintain. The drawbacks - aren't severe. The default package will be for the most recent - release, so it will not have bug-fixes until the next release - (unless you install it with the `--HEAD` option). The release to - `brew` may lag a few days behind because it has to be coordinated - with another team. Still, I'd recommend `brew` if you want to work - from a stable, widely used source. It works well and is really easy - to update. - -2. Downloading the tarball and installing from it is also easy. You have to have a few more command line skills. Updates are easy, too. You just repeat the process with the new binary. This gives you the flexibility to have multiple versions on your computer. If you don't want to use `brew`, then the binary is a good choice. - -3. Compiling from source is the most work. The advantage is that you don't have to wait for a release to add features or bug fixes. The disadvantage is that you need to spend more time managing the setup. It's not a lot, but it's more than with the other two options. - -Since this is a "beginner" how-to, I'm going to cover the first two -options in detail and go over the third more quickly. - -## Brew - -### Step 1: Install `brew` if you haven't already - -Go to the `brew` website, http://brew.sh/, and follow the directions there. The most important step is: - -``` -ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" -``` - -When I did this, I had some problems with directory permissions. Searches on Google pointed me to pages that walked me through updating permissions on the `/usr/local` directory. Seemed scary, but it's worked well since. - -### Step 2: Run the `brew` command to install `hugo` - -```bash -$ brew install hugo -==> Downloading https://homebrew.bintray.com/bottles/hugo-0.21.sierra.bottle.tar.gz -######################################################################## 100,0% -==> Pouring hugo-0.21.sierra.bottle.tar.gz -==> Using the sandbox -==> Caveats -Bash completion has been installed to: - /usr/local/etc/bash_completion.d -==> Summary -🍺 /usr/local/Cellar/hugo/0.21: 32 files, 17.4MB -``` - -(Note: Replace `brew install hugo` with `brew install hugo --HEAD` -if you want the absolute latest version in development, -but beware — there might be bugs!) - -`Brew` should have updated your path to include Hugo. Confirm by opening a new terminal window and running a few commands: - -```bash -$ # show the location of the hugo executable -$ which hugo -/usr/local/bin/hugo - -$ # show the installed version -$ ls -l $( which hugo ) -lrwxr-xr-x 1 mdhender admin 30 Mar 28 22:19 /usr/local/bin/hugo -> ../Cellar/hugo/0.13_1/bin/hugo - -$ # verify that hugo runs correctly -$ hugo version -Hugo Static Site Generator v0.13 BuildDate: 2015-03-09T21:34:47-05:00 -``` - -### Step 3: You're Done - -You've installed Hugo. Now you need to set up your site. Read the -[Quickstart guide](/overview/quickstart/), explore the rest of the -documentation, and if you still have questions -[just ask!](http://discuss.gohugo.io/ "Discussion forum") - -## From Tarball - -### Step 1: Decide on the location - -When installing from the tarball, you have to decide if you're going to install the binary in `/usr/local/bin` or in your home directory. There are three camps on this: - -1. Install it in `/usr/local/bin` so that all the users on your system have access to it. This is a good idea because it's a fairly standard place for executables. The downside is that you may need elevated privileges to put software into that location. Also, if there are multiple users on your system, they will all run the same version. Sometimes this can be an issue if you want to try out a new release. - -2. Install it in `~/bin` so that only you can execute it. This is a good idea because it's easy to do, easy to maintain, and doesn't require elevated privileges. The downside is that only you can run Hugo. If there are other users on your site, they have to maintain their own copies. That can lead to people running different versions. Of course, this does make it easier for you to experiment with different releases. - -3. Install it in your `sites` directory. This is not a bad idea if you have only one site that you're building. It keeps every thing in a single place. If you want to try out new releases, you can just make a copy of the entire site, update the Hugo executable, and have it. - -All three locations will work for you. I'm going to document the second option, mostly because I'm comfortable with it. - -### Step 2: Download the Tarball - -1. Open <https://github.com/gohugoio/hugo/releases> in your browser. - -2. Find the current release by scrolling down and looking for the green tag that reads "Latest Release." - -3. Download the current tarball for the Mac. The name will be something like `hugo_X.Y_osx-64bit.tgz`, where `X.YY` is the release number. - -4. By default, the tarball will be saved to your `~/Downloads` directory. If you chose to use a different location, you'll need to change that in the following steps. - -### Step 3: Confirm your download - -Verify that the tarball wasn't corrupted during the download: - -``` -$ tar tvf ~/Downloads/hugo_X.Y_osx-64bit.tgz --rwxrwxrwx 0 0 0 0 Feb 22 04:02 hugo_X.Y_osx-64bit/hugo_X.Y_osx-64bit.tgz --rwxrwxrwx 0 0 0 0 Feb 22 03:24 hugo_X.Y_osx-64bit/README.md --rwxrwxrwx 0 0 0 0 Jan 30 18:48 hugo_X.Y_osx-64bit/LICENSE.md -``` - -The `.md` files are documentation. The other file is the executable. - -### Step 4: Install into your bin directory - -``` -$ # create the directory if needed -$ mkdir -p ~/bin - -$ # make it the working directory -$ cd ~/bin - -$ # extract the tarball -$ tar -xvzf ~/Downloads/hugo_X.Y_osx-64bit.tgz -Archive: hugo_X.Y_osx-64bit.tgz - x ./ - x ./hugo - x ./LICENSE.md - x ./README.md - -$ # verify that it runs -$ ./hugo version -Hugo Static Site Generator v0.13 BuildDate: 2015-02-22T04:02:30-06:00 -``` - -You may need to add your bin directory to your `PATH` variable. The `which` command will check for us. If it can find `hugo`, it will print the full path to it. Otherwise, it will not print anything. - -``` -$ # check if hugo is in the path -$ which hugo -/Users/USERNAME/bin/hugo -``` - -If `hugo` is not in your `PATH`, add it by updating your `~/.bash_profile` file. First, start up an editor: - -``` -$ nano ~/.bash_profile -``` - -Add a line to update your `PATH` variable: - -``` -export PATH=$PATH:$HOME/bin -``` - -Then save the file by pressing Control-X, then Y to save the file and return to the prompt. - -Close the terminal and then open a new terminal to pick up the changes to your profile. Verify by running the `which hugo` command again. - -### Step 5: You're Done - -You've installed Hugo. Now you need to set up your site. Read the -[Quickstart guide](/overview/quickstart/), explore the rest of the -documentation, and if you still have questions -[just ask!](http://discuss.gohugo.io/ "Discussion forum") - -## Building from Source - -If you want to compile Hugo yourself, you'll need -[Go](http://golang.org), which is also available from Homebrew: `brew -install go`. - -### Step 1: Get the Source - -If you want to compile a specific version, go to -<https://github.com/gohugoio/hugo/releases> and download the source code -for the version of your choice. If you want to compile Hugo with all -the latest changes (which might include bugs), clone the Hugo -repository: - -``` -git clone https://github.com/gohugoio/hugo -``` - -### Step 2: Compiling - -Make the directory containing the source your working directory, then -fetch Hugo's dependencies: - -``` -mkdir -p src/github.com/spf13 -ln -sf $(pwd) src/github.com/gohugoio/hugo - -# set the build path for Go -export GOPATH=$(pwd) - -go get -``` - -This will fetch the absolute latest version of the dependencies, so if -Hugo fails to build it may be because the author of a dependency -introduced a breaking change. - -Then compile: - -``` -go build -o hugo main.go -``` - -Then place the `hugo` executable somewhere in your `$PATH`. - -### Step 3: You're Done - -You probably know where to go from here. diff --git a/docs/content/tutorials/installing-on-windows.md b/docs/content/tutorials/installing-on-windows.md deleted file mode 100644 index d249571f6..000000000 --- a/docs/content/tutorials/installing-on-windows.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -author: "Michael Henderson" -lastmod: 2016-07-18 -date: 2015-03-30 -linktitle: Installing on Windows -toc: true -menu: - main: - parent: tutorials -next: /tutorials/mathjax -prev: /tutorials/installing-on-mac -title: Installing on Windows -weight: 10 ---- - -# Installing Hugo on Windows - -This tutorial aims to be a complete guide to installing Hugo on your Windows computer. - -## Assumptions - -1. We'll call your website `example.com` for the purpose of this tutorial. -2. You will use `C:\Hugo\Sites` as the starting point for your site. -3. You will use `C:\Hugo\bin` to store executable files. - -## Setup Your Directories - -You'll need a place to store the Hugo executable, your content (the files that you build), and the generated files (the HTML that Hugo builds for you). - -1. Open Windows Explorer. -2. Create a new folder: `C:\Hugo` (assuming you want Hugo on your C drive – it can go anywhere.) -3. Create a subfolder in the Hugo folder: `C:\Hugo\bin`. -4. Create another subfolder in Hugo: `C:\Hugo\Sites`. - -## Technical users - -1. Download the latest zipped Hugo executable from the [Hugo Releases](https://github.com/gohugoio/hugo/releases) page. -2. Extract all contents to your `..\Hugo\bin` folder. -3. The hugo executable will be named as `hugo_hugo-version_platform_arch.exe`. Rename that executable to `hugo.exe` for ease of use. -4. In PowerShell or your preferred CLI, add the `hugo.exe` executable to your PATH by navigating to `C:\Hugo\bin` (or the location of your hugo.exe file) and use the command `set PATH=%PATH%;C:\Hugo\bin`. If the `hugo` command does not work after a reboot, you may have to run the command prompt as administrator. - -## Less technical users - -1. Go the [Hugo Releases](https://github.com/gohugoio/hugo/releases) page. -2. The latest release is announced on top. Scroll to the bottom of the release announcement to see the downloads. They're all ZIP files. -3. Find the Windows files near the bottom (they're in alphabetical order, so Windows is last) – download either the 32-bit or 64-bit file depending on whether you have 32-bit or 64-bit Windows. (If you don't know, [see here](https://esupport.trendmicro.com/en-us/home/pages/technical-support/1038680.aspx).) -4. Move the ZIP file into your `C:\Hugo\bin` folder. -5. Double-click on the ZIP file and extract its contents. Be sure to extract the contents into the same `C:\Hugo\bin` folder – Windows will do this by default unless you tell it to extract somewhere else. -6. You should now have three new files: hugo executable (example: hugo_0.18_windows_amd64.exe), license.md, and readme.md. (you can delete the ZIP download now.). Rename that hugo executable (hugo_hugo-version_platform_arch.exe) to hugo.exe for ease of use. -7. Now add Hugo to your Windows PATH settings: - - ### For Windows 10 users: - - - Right click on the **Start** button. - - Click on **System**. - - Click on **Advanced System Settings** on the left. - - Click on the **Environment Variables...** button on the bottom. - - In the User variables section, find the row that starts with PATH (PATH will be all caps). - - Double-click on **PATH**. - - Click the **New...** button. - - Type in the folder where `hugo.exe` was extracted, which is `C:\Hugo\bin` if you went by the instructions above. *The PATH entry should be the folder where Hugo lives, not the binary.* Press <kbd>Enter</kbd> when you're done typing. - - Click OK at every window to exit. - - > <small>Note that the path editor in Windows 10 was added in the large [November 2015 Update](https://blogs.windows.com/windowsexperience/2015/11/12/first-major-update-for-windows-10-available-today/). You'll need to have that or a later update installed for the above steps to work. You can see what Windows 10 build you have by clicking on the <i class="fa fa-windows"></i> Start button → Settings → System → About. See [here](http://www.howtogeek.com/236195/how-to-find-out-which-build-and-version-of-windows-10-you-have/) for more.)</small> - - ### For Windows 7 and 8.x users: - - Windows 7 and 8.1 do not include the easy path editor included in Windows 10, so non-technical users on those platforms are advised to install a free third-party path editor like [Windows Environment Variables Editor](http://eveditor.com/) or [Path Editor](https://patheditor2.codeplex.com/). - -## Verify the executable - -Run a few commands to verify that the executable is ready to run, and then build a sample site to get started. - -1. Open a command prompt window. - -2. At the prompt, type `hugo help` and press the <kbd>Enter</kbd> key. You should see output that starts with: - - {{< nohighlight >}}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/. -{{< /nohighlight >}} - - If you do, then the installation is complete. If you don't, double-check the path that you placed the `hugo.exe` file in and that you typed that path correctly when you added it to your PATH variable. If you're still not getting the output, post a note on the Hugo discussion list (in the `Support` topic) with your command and the output. - -3. At the prompt, change your directory to the `Sites` directory. - - {{< nohighlight >}}C:\Program Files> cd C:\Hugo\Sites -C:\Hugo\Sites> -{{< /nohighlight >}} - -4. Run the command to generate a new site. I'm using `example.com` as the name of the site. - - {{< nohighlight >}}C:\Hugo\Sites> hugo new site example.com -{{< /nohighlight >}} - -5. You should now have a directory at `C:\Hugo\Sites\example.com`. Change into that directory and list the contents. You should get output similar to the following: - - {{< nohighlight >}}C:\Hugo\Sites>cd example.com -C:\Hugo\Sites\example.com>dir - Directory of C:\hugo\sites\example.com - -04/13/2015 10:44 PM <DIR> . -04/13/2015 10:44 PM <DIR> .. -04/13/2015 10:44 PM <DIR> archetypes -04/13/2015 10:44 PM 83 config.toml -04/13/2015 10:44 PM <DIR> content -04/13/2015 10:44 PM <DIR> data -04/13/2015 10:44 PM <DIR> layouts -04/13/2015 10:44 PM <DIR> static - 1 File(s) 83 bytes - 7 Dir(s) 6,273,331,200 bytes free -{{< /nohighlight >}} - -You now have Hugo installed and a site to work with. You need to add a layout (or theme), then create some content. Go to http://gohugo.io/overview/quickstart/ for steps on doing that. - -## Troubleshooting - -@dhersam has created a nice video on common issues: - -{{< youtube c8fJIRNChmU >}} diff --git a/docs/content/tutorials/mathjax.md b/docs/content/tutorials/mathjax.md deleted file mode 100644 index e8d896354..000000000 --- a/docs/content/tutorials/mathjax.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -author: Spencer Lyon -lastmod: 2015-05-22 -date: 2014-03-20 -menu: - main: - parent: tutorials -next: /tutorials/migrate-from-jekyll -prev: /tutorials/installing-on-windows -title: MathJax Support -toc: true -weight: 10 ---- - -## What is MathJax? - -[MathJax](http://www.mathjax.org/) is a JavaScript library that allows the display of mathematical expressions described via a LaTeX-style syntax in the HTML (or Markdown) source of a web page. As it is a pure a JavaScript library, getting it to work within Hugo is fairly straightforward, but does have some oddities that will be discussed here. - -This is not an introduction into actually using MathJax to render typeset mathematics on your website. Instead, this page is a collection of tips and hints for one way to get MathJax working on a website built with Hugo. - -## Enabling MathJax - -The first step is to enable MathJax on pages that you would like to have typeset math. There are multiple ways to do this (adventurous readers can consult the [Loading and Configuring](http://docs.mathjax.org/en/latest/configuration.html) section of the MathJax documentation for additional methods of including MathJax), but the easiest way is to use [the officially recommended secure CDN](https://cdnjs.com/) by including the following HTML snippet in the source of a page: - - <script type="text/javascript" - src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"> - </script> - -One way to ensure that this code is included in all pages is to put it in one of the templates that live in the `layouts/partials/` directory. For example, I have included this in the bottom of my template `footer.html` because I know that the footer will be included in every page of my website. - -### Options and Features - -MathJax is a stable open-source library with many features. I encourage the interested reader to view the [MathJax Documentation](http://docs.mathjax.org/en/latest/index.html), specifically the sections on [Basic Usage](http://docs.mathjax.org/en/latest/index.html#basic-usage) and [MathJax Configuration Options](http://docs.mathjax.org/en/latest/index.html#mathjax-configuration-options). - -## Issues with Markdown - -After enabling MathJax, any math entered in-between proper markers (see documentation) will be processed and typeset in the web page. One issue that comes up, however, with Markdown is that the underscore character (`_`) is interpreted by Markdown as a way to wrap text in `emph` blocks while LaTeX (MathJax) interprets the underscore as a way to create a subscript. This "double speak" of the underscore can result in some unexpected and unwanted behavior. - -### Solution - -There are multiple ways to remedy this problem. One solution is to simply escape each underscore in your math code by entering `\_` instead of `_`. This can become quite tedious if the equations you are entering are full of subscripts. - -Another option is to tell Markdown to treat the MathJax code as verbatim code and not process it. One way to do this is to wrap the math expression inside a `<div>` `</div>` block. Markdown would ignore these sections and they would get passed directly on to MathJax and processed correctly. This works great for display style mathematics, but for inline math expressions the line break induced by the `<div>` is not acceptable. The syntax for instructing Markdown to treat inline text as verbatim is by wrapping it in backticks (`` ` ``). You might have noticed, however, that the text included in between backticks is rendered differently than standard text (on this site these are items highlighted in red). To get around this problem, we could create a new CSS entry that would apply standard styling to all inline verbatim text that includes MathJax code. Below I will show the HTML and CSS source that would accomplish this (note this solution was adapted from [this blog post](http://doswa.com/2011/07/20/mathjax-in-markdown.html)---all credit goes to the original author). - - <script type="text/x-mathjax-config"> - MathJax.Hub.Config({ - tex2jax: { - inlineMath: [['$','$'], ['\\(','\\)']], - displayMath: [['$$','$$'], ['\[','\]']], - processEscapes: true, - processEnvironments: true, - skipTags: ['script', 'noscript', 'style', 'textarea', 'pre'], - TeX: { equationNumbers: { autoNumber: "AMS" }, - extensions: ["AMSmath.js", "AMSsymbols.js"] } - } - }); - </script> - - <script type="text/x-mathjax-config"> - MathJax.Hub.Queue(function() { - // Fix <code> tags after MathJax finishes running. This is a - // hack to overcome a shortcoming of Markdown. Discussion at - // https://github.com/mojombo/jekyll/issues/199 - var all = MathJax.Hub.getAllJax(), i; - for(i = 0; i < all.length; i += 1) { - all[i].SourceElement().parentNode.className += ' has-jax'; - } - }); - </script> - -As before, this content should be included in the HTML source of each page that will be using MathJax. The next code snippet contains the CSS that is used to have verbatim MathJax blocks render with the same font style as the body of the page. - - - code.has-jax {font: inherit; - font-size: 100%; - background: inherit; - border: inherit; - color: #515151;} - -In the CSS snippet, notice the line `color: #515151;`. `#515151` is the value assigned to the `color` attribute of the `body` class in my CSS. In order for the equations to fit in with the body of a web page, this value should be the same as the color of the body. - -### Usage - -With this setup, everything is in place for a natural usage of MathJax on pages generated using Hugo. In order to include inline mathematics, just put LaTeX code in between `` `$ TeX Code $` `` or `` `\( TeX Code \)` ``. To include display style mathematics, just put LaTeX code in between `<div>$$TeX Code$$</div>`. All the math will be properly typeset and displayed within your Hugo generated web page! diff --git a/docs/content/tutorials/migrate-from-jekyll.md b/docs/content/tutorials/migrate-from-jekyll.md deleted file mode 100644 index 0fd5d4af7..000000000 --- a/docs/content/tutorials/migrate-from-jekyll.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -lastmod: 2015-12-24 -date: 2014-03-10 -linktitle: Migrating from Jekyll -toc: true -menu: - main: - parent: tutorials -prev: /tutorials/mathjax -next: /tutorials/create-a-multilingual-site -title: Migrate to Hugo from Jekyll -weight: 10 ---- - -**Note:** Hugo 0.15 comes with a `hugo import jekyll` command, see [import from Jekyll](/commands/hugo_import_jekyll/). -## Move static content to `static` -Jekyll has a rule that any directory not starting with `_` will be copied as-is to the `_site` output. Hugo keeps all static content under `static`. You should therefore move it all there. -With Jekyll, something that looked like - - ▾ <root>/ - ▾ images/ - logo.png - -should become - - ▾ <root>/ - ▾ static/ - ▾ images/ - logo.png - -Additionally, you'll want any files that should reside at the root (such as `CNAME`) to be moved to `static`. - -## Create your Hugo configuration file -Hugo can read your configuration as JSON, YAML or TOML. Hugo supports parameters custom configuration too. Refer to the [Hugo configuration documentation](/overview/configuration/) for details. - -## Set your configuration publish folder to `_site` -The default is for Jekyll to publish to `_site` and for Hugo to publish to `public`. If, like me, you have [`_site` mapped to a git submodule on the `gh-pages` branch](http://blog.blindgaenger.net/generate_github_pages_in_a_submodule.html), you'll want to do one of two alternatives: - -1. Change your submodule to point to map `gh-pages` to public instead of `_site` (recommended). - - git submodule deinit _site - git rm _site - git submodule add -b gh-pages git@github.com:your-username/your-repo.git public - -2. Or, change the Hugo configuration to use `_site` instead of `public`. - - { - .. - "publishDir": "_site", - .. - } - -## Convert Jekyll templates to Hugo templates -That's the bulk of the work right here. The documentation is your friend. You should refer to [Jekyll's template documentation](http://jekyllrb.com/docs/templates/) if you need to refresh your memory on how you built your blog and [Hugo's template](/layout/templates/) to learn Hugo's way. - -As a single reference data point, converting my templates for [heyitsalex.net](http://heyitsalex.net/) took me no more than a few hours. - -## Convert Jekyll plugins to Hugo shortcodes -Jekyll has [plugins](http://jekyllrb.com/docs/plugins/); Hugo has [shortcodes](/doc/shortcodes/). It's fairly trivial to do a port. - -### Implementation -As an example, I was using a custom [`image_tag`](https://github.com/alexandre-normand/alexandre-normand/blob/74bb12036a71334fdb7dba84e073382fc06908ec/_plugins/image_tag.rb) plugin to generate figures with caption when running Jekyll. As I read about shortcodes, I found Hugo had a nice built-in shortcode that does exactly the same thing. - -Jekyll's plugin: - -```ruby -module Jekyll - class ImageTag < Liquid::Tag - @url = nil - @caption = nil - @class = nil - @link = nil - // Patterns - IMAGE_URL_WITH_CLASS_AND_CAPTION = - IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK = /(\w+)(\s+)((https?:\/\/|\/)(\S+))(\s+)"(.*?)"(\s+)->((https?:\/\/|\/)(\S+))(\s*)/i - IMAGE_URL_WITH_CAPTION = /((https?:\/\/|\/)(\S+))(\s+)"(.*?)"/i - IMAGE_URL_WITH_CLASS = /(\w+)(\s+)((https?:\/\/|\/)(\S+))/i - IMAGE_URL = /((https?:\/\/|\/)(\S+))/i - def initialize(tag_name, markup, tokens) - super - if markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK - @class = $1 - @url = $3 - @caption = $7 - @link = $9 - elsif markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION - @class = $1 - @url = $3 - @caption = $7 - elsif markup =~ IMAGE_URL_WITH_CAPTION - @url = $1 - @caption = $5 - elsif markup =~ IMAGE_URL_WITH_CLASS - @class = $1 - @url = $3 - elsif markup =~ IMAGE_URL - @url = $1 - end - end - def render(context) - if @class - source = "<figure class='#{@class}'>" - else - source = "<figure>" - end - if @link - source += "<a href=\"#{@link}\">" - end - source += "<img src=\"#{@url}\">" - if @link - source += "</a>" - end - source += "<figcaption>#{@caption}</figcaption>" if @caption - source += "</figure>" - source - end - end -end -Liquid::Template.register_tag('image', Jekyll::ImageTag) -``` - -is written as this Hugo shortcode: - - <!-- image --> - <figure {{ with .Get "class" }}class="{{.}}"{{ end }}> - {{ with .Get "link"}}<a href="{{.}}">{{ end }} - <img src="{{ .Get "src" }}" {{ if or (.Get "alt") (.Get "caption") }}alt="{{ with .Get "alt"}}{{.}}{{else}}{{ .Get "caption" }}{{ end }}"{{ end }} /> - {{ if .Get "link"}}</a>{{ end }} - {{ if or (or (.Get "title") (.Get "caption")) (.Get "attr")}} - <figcaption>{{ if isset .Params "title" }} - {{ .Get "title" }}{{ end }} - {{ if or (.Get "caption") (.Get "attr")}}<p> - {{ .Get "caption" }} - {{ with .Get "attrlink"}}<a href="{{.}}"> {{ end }} - {{ .Get "attr" }} - {{ if .Get "attrlink"}}</a> {{ end }} - </p> {{ end }} - </figcaption> - {{ end }} - </figure> - <!-- image --> - -### Usage -I simply changed: - - {% image full http://farm5.staticflickr.com/4136/4829260124_57712e570a_o_d.jpg "One of my favorite touristy-type photos. I secretly waited for the good light while we were "having fun" and took this. Only regret: a stupid pole in the top-left corner of the frame I had to clumsily get rid of at post-processing." ->http://www.flickr.com/photos/alexnormand/4829260124/in/set-72157624547713078/ %} - -to this (this example uses a slightly extended version named `fig`, different than the built-in `figure`): - - {{%/* fig class="full" src="http://farm5.staticflickr.com/4136/4829260124_57712e570a_o_d.jpg" title="One of my favorite touristy-type photos. I secretly waited for the good light while we were having fun and took this. Only regret: a stupid pole in the top-left corner of the frame I had to clumsily get rid of at post-processing." link="http://www.flickr.com/photos/alexnormand/4829260124/in/set-72157624547713078/" */%}} - -As a bonus, the shortcode named parameters are, arguably, more readable. - -## Finishing touches -### Fix content -Depending on the amount of customization that was done with each post with Jekyll, this step will require more or less effort. There are no hard and fast rules here except that `hugo server` is your friend. Test your changes and fix errors as needed. - -### Clean up -You'll want to remove the Jekyll configuration at this point. If you have anything else that isn't used, delete it. - -## A practical example in a diff -[Hey, it's Alex](http://heyitsalex.net/) was migrated in less than a _father-with-kids day_ from Jekyll to Hugo. You can see all the changes (and screw-ups) by looking at this [diff](https://github.com/alexandre-normand/alexandre-normand/compare/869d69435bd2665c3fbf5b5c78d4c22759d7613a...b7f6605b1265e83b4b81495423294208cc74d610). |