diff options
Diffstat (limited to 'docs')
78 files changed, 570 insertions, 11740 deletions
diff --git a/docs/.gitignore b/docs/.gitignore index dd088ba8f..190dfb1ab 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,3 +1,4 @@ /.idea /public nohup.out +.DS_Store diff --git a/docs/config.toml b/docs/config.toml index 53e4e9afa..4b60aac58 100644 --- a/docs/config.toml +++ b/docs/config.toml @@ -103,6 +103,18 @@ twitter = "GoHugoIO" angledQuotes = false latexDashes = true +[imaging] +# See https://github.com/disintegration/imaging +# CatmullRom is a sharp bicubic filter which should fit the docs site well with its many screenshots. +# Note that you can also set this per image processing. +resampleFilter = "CatmullRom" + +# Defatult JPEG quality setting. Default is 75. +quality = 75 + +anchor = "smart" + + ## As of v0.20, all content files include a default "categories" value that's the same as the section. This was a cheap future-proofing method and should/could be changed accordingly. [taxonomies] category = "categories" @@ -238,6 +250,12 @@ twitter = "GoHugoIO" identifier = "themes" url = "https://themes.gohugo.io/" + [[menu.global]] + name = "Showcase" + weight = 20 + identifier = "showcase" + url = "/showcase/" + # Anything with a weight > 100 gets an external icon [[menu.global]] name = "Community" diff --git a/docs/content/_index.md b/docs/content/_index.md index ec8883c44..c8976eb94 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -1,5 +1,5 @@ --- -title: "A Fast and Flexible Website Generator" +title: "The world’s fastest framework for building websites" date: 2017-03-02T12:00:00-05:00 features: - heading: Blistering Speed diff --git a/docs/content/about/what-is-hugo.md b/docs/content/about/what-is-hugo.md index db947e2f9..2c7339f7c 100644 --- a/docs/content/about/what-is-hugo.md +++ b/docs/content/about/what-is-hugo.md @@ -7,7 +7,7 @@ publishdate: 2017-02-01 lastmod: 2017-02-01 layout: single menu: - main: + docs: parent: "about" weight: 10 weight: 10 diff --git a/docs/content/content-management/_index.md b/docs/content/content-management/_index.md index a2fbce523..28f2ecf82 100644 --- a/docs/content/content-management/_index.md +++ b/docs/content/content-management/_index.md @@ -17,4 +17,4 @@ aliases: [/content/,/content/organization] toc: false --- -A static site generator needs to extend beyond front matter and a couple templates to be both scalable and *manageable*. Hugo was designed with not only developers in mind, but also content managers and authors. +A static site generator needs to extend beyond front matter and a couple of templates to be both scalable and *manageable*. Hugo was designed with not only developers in mind, but also content managers and authors. diff --git a/docs/content/content-management/organization/index.md b/docs/content/content-management/organization/index.md index 742a9e5fe..b810f6179 100644 --- a/docs/content/content-management/organization/index.md +++ b/docs/content/content-management/organization/index.md @@ -29,7 +29,7 @@ The illustration shows 3 bundles. Note that the home page bundle cannot contain {{% note %}} -The bundle docuementation is **work in progress**. We will publish more comprehensive docs about this soon. +The bundle documentation is **work in progress**. We will publish more comprehensive docs about this soon. {{% /note %}} diff --git a/docs/content/content-management/urls.md b/docs/content/content-management/urls.md index f0d9dca41..c2c08a4d4 100644 --- a/docs/content/content-management/urls.md +++ b/docs/content/content-management/urls.md @@ -161,7 +161,7 @@ Assuming a `baseURL` of `example.com`, the contents of the auto-generated alias </html> ``` -The `http-equiv="refresh"` line is what performs the redirect, in 0 seconds in this case. If an end user of your website goes to `https://example.com/posts/my-old-url`, they will now be automatically redirected to the newer, correct URL. The addition of `<meta name="robots" content="noindex">` lets search engine bots know they they should not crawl and index your new alias page. +The `http-equiv="refresh"` line is what performs the redirect, in 0 seconds in this case. If an end user of your website goes to `https://example.com/posts/my-old-url`, they will now be automatically redirected to the newer, correct URL. The addition of `<meta name="robots" content="noindex">` lets search engine bots know that they should not crawl and index your new alias page. ### Customize You may customize this alias page by creating an `alias.html` template in the diff --git a/docs/content/getting-started/installing.md b/docs/content/getting-started/installing.md index d9ded804d..eb605c2a6 100644 --- a/docs/content/getting-started/installing.md +++ b/docs/content/getting-started/installing.md @@ -67,22 +67,23 @@ choco install hugo -confirm * [Git][installgit] * [Go (latest or previous version)][installgo] -* [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 because the command is not vendor aware. *You must use `govendor` to fetch Hugo's dependencies.* +Hugo uses [dep][] 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 because the command is not vendor aware. + +The simplest way is to use [mage][] (a Make alternative for Go projects.) #### Fetch from GitHub {{< code file="from-gh.sh" >}} -go get github.com/kardianos/govendor -govendor get github.com/gohugoio/hugo -go install github.com/gohugoio/hugo +go get github.com/magefile/mage +go get -d github.com/gohugoio/hugo +cd $HOME/go/src/github.com/gohugoio/hugo +mage vendor +mage install {{< /code >}} -`govendor get` will fetch Hugo and all its dependent libraries to `$GOPATH/src/github.com/gohugoio/hugo`, and `go install` compiles everything into a final `hugo` (or `hugo.exe`) executable inside `$GOPATH/bin/`. - {{% note %}} If you are a Windows user, substitute the `$HOME` environment variable above with `%USERPROFILE%`. {{% /note %}} @@ -486,7 +487,8 @@ Now that you've installed Hugo, read the [Quick Start guide][quickstart] and exp [content]: /content-management/ [@dhersam]: https://github.com/dhersam [forum]: https://discourse.gohugo.io -[govendor]: https://github.com/kardianos/govendor +[mage]: https://github.com/magefile/mage +[dep]: https://github.com/golang/dep [highlight shortcode]: /content-management/shortcodes/#highlight [installgit]: http://git-scm.com/ [installgo]: https://golang.org/dl/ diff --git a/docs/content/hosting-and-deployment/deployment-with-wercker.md b/docs/content/hosting-and-deployment/deployment-with-wercker.md index 9b41ed793..ac9d7a3e6 100644 --- a/docs/content/hosting-and-deployment/deployment-with-wercker.md +++ b/docs/content/hosting-and-deployment/deployment-with-wercker.md @@ -128,7 +128,7 @@ git push -u origin master ## Set Up Wercker -To sign up for a free Wercker account, go to <https://wercker.com> and click the the **Sign Up** button on the top right of the home screen. +To sign up for a free Wercker account, go to <https://wercker.com> and click the **Sign Up** button on the top right of the home screen. ![][3] diff --git a/docs/content/hosting-and-deployment/hosting-on-keycdn.md b/docs/content/hosting-and-deployment/hosting-on-keycdn.md index 78337c138..05bac2ff4 100644 --- a/docs/content/hosting-and-deployment/hosting-on-keycdn.md +++ b/docs/content/hosting-and-deployment/hosting-on-keycdn.md @@ -24,7 +24,7 @@ draft: false ## Create a KeyCDN Pull Zone -The first step will be to login to your KeyCDN account and create a new zone. Name this whatever you like and select the [Pull Zone](https://www.keycdn.com/support/create-a-pull-zone/) option. As for the the origin URL, your site will be running on [GitLab Pages](https://docs.gitlab.com/ee/user/project/pages/getting_started_part_one.html) with a URL of `https://youruser.gitlab.io/reponame/`. Use this as the Origin URL. +The first step will be to login to your KeyCDN account and create a new zon |