diff --git a/content/command/_index.md b/content/command/_index.md deleted file mode 100644 index 2cd6860bb..000000000 --- a/content/command/_index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Command Line Reference -linktitle: CLI -description: Comprehensive list of Hugo templating functions, including basic and advanced usage examples. -date: 2017-02-01 -publishdate: 2017-02-01 -lastmod: 2017-02-01 -tags: [functions,templating] -weight: 01 -draft: false -slug: -aliases: [] -notesforauthors: ---- \ No newline at end of file diff --git a/content/commands/_index.md b/content/commands/_index.md new file mode 100644 index 000000000..c339aa119 --- /dev/null +++ b/content/commands/_index.md @@ -0,0 +1,22 @@ +--- +title: Command Line Reference +linktitle: Command Line Reference +description: Comprehensive list of Hugo templating functions, including basic and advanced usage examples. +date: 2017-02-01 +publishdate: 2017-02-01 +lastmod: 2017-02-01 +categories: [command line reference] +tags: [cli,command line] +weight: 01 +draft: false +aliases: [/cli/] +needsreview: true +--- + +The following list contains auto-generated and up-to-date (thanks to [Cobra][]) documentation for all the CLI commands in Hugo. + + + + + +[Cobra]: https://github.com/spf13/cobra \ No newline at end of file diff --git a/content/content-management/url-management.md b/content/content-management/url-management.md index 688e06213..e77335bc6 100644 --- a/content/content-management/url-management.md +++ b/content/content-management/url-management.md @@ -11,7 +11,7 @@ weight: 90 draft: false aliases: [/extras/permalinks/,/extras/aliases/,/content-management/permalinks-and-redirects/,/extras/urls/] toc: true -notesforauthors: +needsreview: true --- ## Base URL @@ -107,6 +107,6 @@ Setting `relativeURLs` to `true` in the site configuration will cause Hugo to re For example, if the `/post/first/` page contained a link with a relative URL of `/about/`, Hugo would rewrite that URL to `../../about/`. [Content Organization]: /content-management/content-organization/ -[flag from the command line]: /developer-tools/hugo-command-line-reference/#flags +[flag from the command line]: /getting-started/basic-usage/ [sections]: /content-management/content-sections/ [site configuration]: /project-organization/configuration/ \ No newline at end of file diff --git a/content/contribute-to-hugo/contribute-to-hugo-development.md b/content/contribute-to-hugo/contribute-to-hugo-development.md index 0f9cf78f0..60ce40a0e 100644 --- a/content/contribute-to-hugo/contribute-to-hugo-development.md +++ b/content/contribute-to-hugo/contribute-to-hugo-development.md @@ -75,7 +75,7 @@ If you're going to contribute code, you'll need to have an account on GitHub. Go ## Installing Git on Your System -You will need to have Git installed on your computer to contribute to Hugo development. Teaching git is outside the scope of the Hugo docs, but if you're looking for an excellent reference to learn the basics of Git, we recommend the [Git book](https://git-scm.com/) if you are not sure where to begin. The used terminology will be explained with annotations. +You will need to have Git installed on your computer to contribute to Hugo development. Teaching git is outside the scope of the Hugo docs, but if you're looking for an excellent reference to learn the basics of Git, we recommend the [Git book][gitbook] 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. @@ -322,7 +322,7 @@ 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 (aka "squashed"). Save the file (CTRL+S) and close the editor again. +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 (aka "squashed"). Save the file with CTRL+S 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: @@ -374,16 +374,17 @@ If you have questions leave a comment in the pull request. We are willing to ass Thank you for reading this tutorial. Hopefully, we see you again on GitHub. There are plenty of [open issues](https://github.com/spf13/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. -## Additional References for Learning Git +## Learning Git References * [Codecademy's Free "Learn Git" Course][codecademy] * [Code School and GitHub's Free "Try Git" Tutorial][trygit] -* +* [The Git Book][gitbook] [codecademy]: https://www.codecademy.com/learn/learn-git [contributors]: https://github.com/spf13/hugo/graphs/contributors [downloadgo]: https://golang.org/dl/ +[gitbook]: https://git-scm.com/ [gvm]: https://github.com/moovweb/gvm [installgo]: https://golang.org/doc/install [releases]: /getting-started/ diff --git a/content/developer-tools/hugo-command-line-reference.md b/content/developer-tools/hugo-command-line-reference.md deleted file mode 100644 index 33e49c204..000000000 --- a/content/developer-tools/hugo-command-line-reference.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Hugo Command Line Reference -linktitle: Hugo Command Line Reference -description: -date: 2017-02-01 -publishdate: 2017-02-01 -lastmod: 2017-02-01 -tags: [usage] -categories: [developer tools] -weight: 40 -draft: false -slug: -aliases: [] -toc: true -notesforauthors: ---- - -## Generators - -## Flags \ No newline at end of file diff --git a/content/getting-started/basic-usage.md b/content/getting-started/basic-usage.md index 34949078c..1f1dfa8e4 100644 --- a/content/getting-started/basic-usage.md +++ b/content/getting-started/basic-usage.md @@ -15,10 +15,17 @@ needsreview: true notesforauthors: --- -Once you have [installed Hugo][install] is in your `PATH` (or provide a path to it). Test this by: +## Testing Installation with Hugo Help + +Once you have [installed Hugo][install], make sure it is in your `PATH` (or provide a path to it). You can test that Hugo has been installed correctly via the `help` command: ```bash hugo help +``` + +The output you see in your console should be similar to the following: + +```bash 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. @@ -83,7 +90,6 @@ Additional help topics: Use "hugo [command] --help" for more information about a command. ``` -## Common Usage Example The most common use is probably to run `hugo` with your current directory being the input directory: @@ -98,11 +104,11 @@ hugo in 120 ms ``` -This generates your web site to the `public/` directory, ready to be deployed to your web server. +This generates your website 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: +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: ```bash hugo -s ~/Code/hugo/docs @@ -140,7 +146,7 @@ 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. -## LiveReload +### LiveReload Hugo comes with [LiveReload](https://github.com/livereload/livereload-js) 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: @@ -197,31 +203,17 @@ After running `hugo server` for local web development, you need to do a final `h 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/ +[Apache][], [nginx][], [IIS][]...any web server software will work. {{% warning "Generated Files are **NOT** Removed on Site Build" %}} - +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 or future posts) being left in the generated site. {{% /warning %}} -### A Note About Deployment +### Destination Directories for Dev vs Deploy -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 or future posts) being left in the generated site. +Hugo does not remove generated files before building. An easy workaround is to use different directories for development and production. -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. +To start a server that builds draft content (helpful for editing), you can specify a different destination; e.g., a `dev/` directory: ```bash hugo server -wDs ~/Code/hugo/docs -d dev @@ -237,18 +229,20 @@ This prevents content you're not yet ready to share from accidentally becoming a ### Using Hugo's Server in Production -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 Golang heritage), some users prefer using Hugo itself to serve their website *on their production server*. +Because Hugo is so blazingly fast both in website creation *and* in web serving (thanks to its concurrent, multi-threaded design and Golang heritage), some users prefer to use Hugo itself to serve their website *on their production server*. No other web server software (e.g., Apache, nginx, IIS) is necessary. Here is the command: +{{% input "hugo-production-server.sh" %}} ```bash hugo server --baseURL=http://yoursite.org/ \ --port=80 \ --appendPort=false \ --bind=87.245.198.50 ``` +{{% /input %}} 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. @@ -258,5 +252,15 @@ 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) - -[install]: /getting-started/install-hugo/ \ No newline at end of file +[Amazon S3]: http://aws.amazon.com/s3/ +[Apache]: http://httpd.apache.org/ "Apache HTTP Server" +[CloudFront]: http://aws.amazon.com/cloudfront/ "Amazon CloudFront" +[DreamHost]: http://www.dreamhost.com/ +[Firebase Hosting]: https://firebase.google.com/docs/hosting/ +[GitHub Pages]: https://pages.github.com/ +[GitLab]: https://about.gitlab.com +[GoDaddy]: https://www.godaddy.com/ +[Heroku]: https://www.heroku.com/ +[IIS]: http://www.iis.net/ +[install]: /getting-started/install-hugo/ +[nginx]: http://nginx.org/ \ No newline at end of file diff --git a/content/themes/installing-and-using-themes.md b/content/themes/installing-and-using-themes.md index 3e5422ef8..f3ddb6269 100644 --- a/content/themes/installing-and-using-themes.md +++ b/content/themes/installing-and-using-themes.md @@ -98,6 +98,6 @@ The `themename` in the above examples must match the name of the specific theme {{% /note %}} [customizethemes]: /themes/customizing-a-theme/ -[flag]: /developer-tools/hugo-command-line-reference/#flags "See the full list of flags available via the Hugo CLI." +[flag]: /getting-started/basic-usage/ "See the full list of flags in Hugo's basic usage." [configuration]: /project-organization/configuration/ "Learn how to customize your Hugo website configuration file in yaml, toml, or json." [themesrepo]: https://github.com/spf13/hugoThemes \ No newline at end of file diff --git a/data/sitenavigation.yml b/data/sitenavigation.yml index 70d21d389..16b3024ee 100644 --- a/data/sitenavigation.yml +++ b/data/sitenavigation.yml @@ -12,99 +12,92 @@ gettingstarted: haschildren: true sortsubpagesby: "weight" desc: "Quick start, cross-platform installation, configuration, basic usage, and directory structure" -# projectorganization: -# order: 3 -# title: "Project Organization" -# url: "project-organization" -# haschildren: true -# sortsubpagesby: "weight" -# desc: "Site configuration, scaffolding of new projects, and source organization" contentmanagement: - order: 4 + order: 3 title: "Content Management" url: "content-management" haschildren: true sortsubpagesby: "weight" desc: "Summaries, shortcodes, archetypes, permalinks, front matter, and supported content formats" templates: - order: 5 + order: 4 title: "Templates" url: "templates" haschildren: true sortsubpagesby: "weight" desc: "Pagination, homepage, rss, sitemap, lookup order, and data templates" functions: - order: 6 + order: 5 title: "Functions" url: "functions" haschildren: true sortsubpagesby: "title" desc: "Comprehensive list of Hugo templating functions, including basic and advanced usage examples" variablesandparams: - order: 7 + order: 6 title: "Variables and Params" url: "variables-and-params" haschildren: true sortsubpagesby: "weight" desc: "Page-, file-, taxonomy-, and site-level variables and parameters available in templates" themes: - order: 8 + order: 7 title: "Themes" url: "themes" haschildren: true sortsubpagesby: "weight" desc: "Install, use, and create your own Hugo themes" hostinganddeployment: - order: 9 + order: 8 title: "Hosting and Deployment" url: "hosting-and-deployment" haschildren: true sortsubpagesby: "weight" desc: "Site builds, automated deployments, and popular hosting solutions, as explained by the Hugo community" -# migratingtohugo: -# order: 10 -# title: "Migrating to Hugo" -# url: "migrating-to-hugo" -# haschildren: true -# sortsubpagesby: "weight" -# desc: "Tools for migrating to Hugo from other platforms or generators (eg, Wordpress or Jekyll)" tutorials: - order: 11 + order: 9 title: "Tutorials" url: "tutorials" haschildren: true sortsubpagesby: "weight" desc: "Community-aggregated articles and code examples for approaching different projects using Hugo" developertools: - order: 12 + order: 10 title: "Developer Tools" url: "developer-tools" haschildren: true sortsubpagesby: "weight" desc: "Command line reference, syntax highlighting, and migration tools" +commands: + order: 11 + title: "Command Line Reference" + url: "commands" + haschildren: false + sortsubpagesby: false + desc: "Hugo's easy-to-use but extensive command line interface" troubleshooting: - order: 13 + order: 12 title: "Troubleshooting" url: "troubleshooting" haschildren: true sortsubpagesby: "weight" desc: "Known issues and workarounds, as well as FAQs pulled from the Hugo discussion forum" news: - order: 14 + order: 13 title: "News" url: "news" haschildren: true sortsubpagesby: "weight" desc: "Articles featuring Hugo, as well as updates and release notes for the project" siteshowcase: - order: 15 + order: 14 title: "Site Showcase" url: "showcase" haschildren: false sortsubpagesby: "weight" desc: "A collection of websites built using Hugo" contributetohugo: - order: 16 + order: 15 title: "Contribute to Hugo" url: "contribute-to-hugo" haschildren: true diff --git a/dev-and-design-resources/commands.afdesign b/dev-and-design-resources/commands.afdesign new file mode 100644 index 000000000..9a1b106c4 Binary files /dev/null and b/dev-and-design-resources/commands.afdesign differ diff --git a/static/images/favicons/android-chrome-144x144.png b/static/images/favicons/android-chrome-144x144.png new file mode 100644 index 000000000..975cb33ba Binary files /dev/null and b/static/images/favicons/android-chrome-144x144.png differ diff --git a/static/images/favicons/android-chrome-192x192.png b/static/images/favicons/android-chrome-192x192.png index f2811ae18..7ab6c3849 100644 Binary files a/static/images/favicons/android-chrome-192x192.png and b/static/images/favicons/android-chrome-192x192.png differ diff --git a/static/images/favicons/android-chrome-256x256.png b/static/images/favicons/android-chrome-256x256.png new file mode 100644 index 000000000..ed88a2224 Binary files /dev/null and b/static/images/favicons/android-chrome-256x256.png differ diff --git a/static/images/favicons/android-chrome-36x36.png b/static/images/favicons/android-chrome-36x36.png new file mode 100644 index 000000000..3695eb088 Binary files /dev/null and b/static/images/favicons/android-chrome-36x36.png differ diff --git a/static/images/favicons/android-chrome-48x48.png b/static/images/favicons/android-chrome-48x48.png new file mode 100644 index 000000000..ca275dad6 Binary files /dev/null and b/static/images/favicons/android-chrome-48x48.png differ diff --git a/static/images/favicons/android-chrome-512x512.png b/static/images/favicons/android-chrome-512x512.png deleted file mode 100644 index de4338502..000000000 Binary files a/static/images/favicons/android-chrome-512x512.png and /dev/null differ diff --git a/static/images/favicons/android-chrome-72x72.png b/static/images/favicons/android-chrome-72x72.png new file mode 100644 index 000000000..966891f25 Binary files /dev/null and b/static/images/favicons/android-chrome-72x72.png differ diff --git a/static/images/favicons/android-chrome-96x96.png b/static/images/favicons/android-chrome-96x96.png new file mode 100644 index 000000000..feb1d3ebf Binary files /dev/null and b/static/images/favicons/android-chrome-96x96.png differ diff --git a/static/images/favicons/apple-touch-icon.png b/static/images/favicons/apple-touch-icon.png index e15f8b1c7..ecf1fc020 100644 Binary files a/static/images/favicons/apple-touch-icon.png and b/static/images/favicons/apple-touch-icon.png differ diff --git a/static/images/favicons/browserconfig.xml b/static/images/favicons/browserconfig.xml index 4a718762c..62400c5f2 100644 --- a/static/images/favicons/browserconfig.xml +++ b/static/images/favicons/browserconfig.xml @@ -1,9 +1,10 @@ - - - - - - #2b5797 - - - + + + + + + + #2d89ef + + + diff --git a/static/images/favicons/favicon-16x16.png b/static/images/favicons/favicon-16x16.png index d20106d16..c62ce6fb2 100644 Binary files a/static/images/favicons/favicon-16x16.png and b/static/images/favicons/favicon-16x16.png differ diff --git a/static/images/favicons/favicon-32x32.png b/static/images/favicons/favicon-32x32.png index 2288d98b1..57a018e35 100644 Binary files a/static/images/favicons/favicon-32x32.png and b/static/images/favicons/favicon-32x32.png differ diff --git a/static/images/favicons/favicon.ico b/static/images/favicons/favicon.ico index 58048a4e2..dc007a99e 100644 Binary files a/static/images/favicons/favicon.ico and b/static/images/favicons/favicon.ico differ diff --git a/static/images/favicons/manifest.json b/static/images/favicons/manifest.json index a2e66bbee..4fbd2f6b9 100644 --- a/static/images/favicons/manifest.json +++ b/static/images/favicons/manifest.json @@ -1,17 +1,42 @@ { - "name": "Hugo", - "icons": [ - { - "src": "\/images\/favicons\/android-chrome-192x192.png", - "sizes": "192x192", - "type": "image\/png" - }, - { - "src": "\/images\/favicons\/android-chrome-512x512.png", - "sizes": "512x512", - "type": "image\/png" - } - ], - "theme_color": "#ffffff", - "display": "standalone" -} + "name": "Hugo", + "icons": [ + { + "src": "images/favicons/android-chrome-36x36.png", + "sizes": "36x36", + "type": "image/png" + }, + { + "src": "images/favicons/android-chrome-48x48.png", + "sizes": "48x48", + "type": "image/png" + }, + { + "src": "images/favicons/android-chrome-72x72.png", + "sizes": "72x72", + "type": "image/png" + }, + { + "src": "images/favicons/android-chrome-96x96.png", + "sizes": "96x96", + "type": "image/png" + }, + { + "src": "images/favicons/android-chrome-144x144.png", + "sizes": "144x144", + "type": "image/png" + }, + { + "src": "images/favicons/android-chrome-192x192.png", + "sizes": "192x192", + "type": "image/png" + }, + { + "src": "images/favicons/android-chrome-256x256.png", + "sizes": "256x256", + "type": "image/png" + } + ], + "theme_color": "#ffffff", + "background_color": "#ffffff" +} \ No newline at end of file diff --git a/static/images/favicons/mstile-144x144.png b/static/images/favicons/mstile-144x144.png new file mode 100644 index 000000000..e54b4bd75 Binary files /dev/null and b/static/images/favicons/mstile-144x144.png differ diff --git a/static/images/favicons/mstile-150x150.png b/static/images/favicons/mstile-150x150.png index e2bfbfbef..c7b84c690 100644 Binary files a/static/images/favicons/mstile-150x150.png and b/static/images/favicons/mstile-150x150.png differ diff --git a/static/images/favicons/mstile-310x310.png b/static/images/favicons/mstile-310x310.png new file mode 100644 index 000000000..2cde5c08c Binary files /dev/null and b/static/images/favicons/mstile-310x310.png differ diff --git a/static/images/favicons/safari-pinned-tab.svg b/static/images/favicons/safari-pinned-tab.svg index c9bf12b9a..80ff2dae3 100644 --- a/static/images/favicons/safari-pinned-tab.svg +++ b/static/images/favicons/safari-pinned-tab.svg @@ -2,42 +2,21 @@ Created by potrace 1.11, written by Peter Selinger 2001-2013 - - + diff --git a/static/images/hugo-icons/commands.svg b/static/images/hugo-icons/commands.svg new file mode 100644 index 000000000..89474b208 --- /dev/null +++ b/static/images/hugo-icons/commands.svg @@ -0,0 +1,36 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/themes/hugodocs/layouts/partials/head/metadata-favicons.html b/themes/hugodocs/layouts/partials/head/metadata-favicons.html index 52ec59ff6..7e8b422b9 100644 --- a/themes/hugodocs/layouts/partials/head/metadata-favicons.html +++ b/themes/hugodocs/layouts/partials/head/metadata-favicons.html @@ -1,22 +1,11 @@ - - - - - - - - - + - - - - + \ No newline at end of file diff --git a/themes/hugodocs/layouts/section/commands.html b/themes/hugodocs/layouts/section/commands.html index 3a5be83d8..ecca411a7 100644 --- a/themes/hugodocs/layouts/section/commands.html +++ b/themes/hugodocs/layouts/section/commands.html @@ -1,8 +1,16 @@ {{ define "main" }} -

Hugo Commands

-{{.Content}} -{{ range .Data.Pages }} -
  • {{ .Title }}
    • -{{ end }} - +
    +
    + {{partial "breadcrumb.html" . }} +

    + {{- partial "list-icon.html" . -}} + {{- .Title | markdownify -}}

    + {{partial "content-header-links.html" . }} + {{partial "tags.html" . }} +
    +
    + {{.Content}} + {{partial "contents-list.html" .}} +
    +
    {{ end }} \ No newline at end of file