diff options
| author | Anthony Fok <foka@debian.org> | 2015-01-27 19:17:09 -0700 |
|---|---|---|
| committer | Anthony Fok <foka@debian.org> | 2015-01-28 18:02:40 -0700 |
| commit | ba44e860a33cdc121453adbc02601f48504bc798 (patch) | |
| tree | 7bb8c6098e42c5f1d7f79db9d0c68d5919d65ad4 | |
| parent | 82d4b8ab4024bfab5e844ca662c9bcbba9e14d2c (diff) | |
[Docs] Copyediting
* Add meta author, description and generator tags
* Add Hugo version beside the logo and in the footer
* Suggest the user to run `go get -u -v` to update dependencies
* Requires Go 1.3+ rather than Go 1.1+
* Improve rendering/formatting in some places
* Add trailing slash to URLs where appropriate
* GitHub redirects all http requests to https, update accordingly
62 files changed, 318 insertions, 294 deletions
@@ -1,6 +1,6 @@ # Hugo -A Fast and Flexible Static Site Generator built with love by [spf13](http://spf13.com) -and [friends](http://github.com/spf13/hugo/graphs/contributors) in Go. +A Fast and Flexible Static Site Generator built with love by [spf13](http://spf13.com/) +and [friends](https://github.com/spf13/hugo/graphs/contributors) in Go. [](https://travis-ci.org/spf13/hugo) [](https://app.wercker.com/project/bykey/1a0de7d703ce3b80527f00f675e1eb32) @@ -21,7 +21,7 @@ takes around 1 millisecond for each piece of content. It is written to work well with any kind of website including blogs, tumbles and docs. -**Complete documentation is available at [Hugo Documentation](http://gohugo.io).** +**Complete documentation is available at [Hugo Documentation](http://gohugo.io/).** # Getting Started @@ -51,7 +51,7 @@ is the most probable location. #### Dependencies * Git -* Go 1.1+ (Go 1.4+ on Windows, see Go [Issue #8090](https://code.google.com/p/go/issues/detail?id=8090)) +* Go 1.3+ (Go 1.4+ on Windows, see Go [Issue #8090](https://code.google.com/p/go/issues/detail?id=8090)) * Mercurial * Bazaar @@ -69,10 +69,17 @@ it's helpful to symlink the project to one of the following paths: #### Get directly from GitHub: -If you only want to build from source, it's even easier. +If you only want to build from source, it's even easier: go get -v github.com/spf13/hugo +Once completed, your may find your new `hugo` (or `hugo.exe`) executable +sitting inside `$GOPATH/bin/`. + +You may also run `go get` with the `-u` option to update Hugo’s dependencies: + + go get -u -v github.com/spf13/hugo + #### Building Hugo cd /path/to/hugo @@ -124,7 +131,7 @@ We welcome your contributions. To make the process as seamless as possible, we * Squash your commits into a single commit. `git rebase -i`. It's okay to force update your pull request. * Make sure `go test ./...` passes, and `go build` completes. Our Travis CI loop will catch most things that are missing. The exception: Windows. We run on Windows from time to time, but if you have access, please check on a Windows machine too. -**Complete documentation is available at [Hugo Documentation](http://gohugo.io).** +**Complete documentation is available at [Hugo Documentation](http://gohugo.io/).** [](https://github.com/igrigorik/ga-beacon) [](https://bitdeli.com/free "Bitdeli Badge") diff --git a/docs/archetypes/showcase.md b/docs/archetypes/showcase.md index f4c5afff8..ebe87035a 100644 --- a/docs/archetypes/showcase.md +++ b/docs/archetypes/showcase.md @@ -3,8 +3,8 @@ date: 2013-07-01T07:32:00Z description: "" license: "" licenseLink: "" -sitelink: http://spf13.com -sourceLink: http://github.com/spf13/spf13.com +sitelink: http://spf13.com/ +sourceLink: https://github.com/spf13/spf13.com tags: - personal - blog diff --git a/docs/config.toml b/docs/config.toml index 295636ac2..a9560d2aa 100644 --- a/docs/config.toml +++ b/docs/config.toml @@ -1,6 +1,10 @@ baseurl = "http://gohugo.io/" MetaDataFormat = "yaml" +[params] + description = "Documentation of Hugo, a fast and flexible static site generator built with love by spf13 and friends in Go" + author = "Steve Francia (spf13) and friends" + [indexes] tag = "tags" group = "groups" @@ -18,7 +22,7 @@ MetaDataFormat = "yaml" [[menu.main]] name = "Discuss Hugo" pre = "<i class='fa fa-comments'></i>" - url = "http://discuss.gohugo.io" + url = "http://discuss.gohugo.io/" weight = -150 [[menu.main]] name = "About Hugo" diff --git a/docs/content/community/contributing.md b/docs/content/community/contributing.md index 6119ffb13..d41fc32a1 100644 --- a/docs/content/community/contributing.md +++ b/docs/content/community/contributing.md @@ -13,7 +13,7 @@ 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 -or contact [spf13](http://spf13.com) about what may make sense +or contact [spf13](http://spf13.com/) 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.* diff --git a/docs/content/community/mailing-list.md b/docs/content/community/mailing-list.md index 95e6ce603..efe734e55 100644 --- a/docs/content/community/mailing-list.md +++ b/docs/content/community/mailing-list.md @@ -11,7 +11,7 @@ weight: 10 ## Discussion Forum -Hugo has its own [discussion forum](http://discuss.gohugo.io) powered by [Discourse](http://www.discourse.org/). +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. @@ -26,7 +26,7 @@ https://groups.google.com/forum/#!forum/hugo-announce ### Discussion (Archive) -**This has been replaced with the [Hugo discussion forum](http://discuss.gohugo.io).** +**This has been replaced with the [Hugo discussion forum](http://discuss.gohugo.io/).** It is available for archival purposes. diff --git a/docs/content/content/ordering.md b/docs/content/content/ordering.md index 910aba74d..07600b34d 100644 --- a/docs/content/content/ordering.md +++ b/docs/content/content/ordering.md @@ -15,7 +15,7 @@ Hugo provides you with all the flexibility you need to organize how your content 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). +the [list template](/templates/list/). _Both the `date` and `weight` fields are optional._ diff --git a/docs/content/content/organization.md b/docs/content/content/organization.md index 7908acbef..bf32aa699 100644 --- a/docs/content/content/organization.md +++ b/docs/content/content/organization.md @@ -22,7 +22,7 @@ in the front matter. 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). +in Hugo and is used as the [section](/content/sections/). . └── content @@ -72,16 +72,16 @@ destination. ### filepath The actual path to the file on disk. Destination will create the destination -with the same path. Includes [section](/content/sections). +with the same path. Includes [section](/content/sections/). ### section section can be provided in the front matter overriding the section derived from -the source content location on disk. See [section](/content/sections). +the source content location on disk. See [section](/content/sections/). ### 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). +path. Includes [section](/content/sections/). ### url A complete URL can be provided. This will override all the above as it pertains diff --git a/docs/content/content/sections.md b/docs/content/content/sections.md index 602e89a08..03002a42f 100644 --- a/docs/content/content/sections.md +++ b/docs/content/content/sections.md @@ -12,7 +12,7 @@ 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 +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". @@ -32,7 +32,7 @@ The following example site uses two sections, "post" and "quote". ## 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) +of the content in that section. See [List Templates](/templates/list/) for details on customizing the way they appear. ## Sections and Types diff --git a/docs/content/content/summaries.md b/docs/content/content/summaries.md index dc159d49f..04a4db695 100644 --- a/docs/content/content/summaries.md +++ b/docs/content/content/summaries.md @@ -23,7 +23,7 @@ By default, Hugo automatically takes the first 70 words of your content as its s ## User-defined: manual summary split: -Alternatively, you may adding the <code><!--more--></code> summary divider[^1] 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. +Alternatively, you may add the <code><!--more--></code> summary divider[^1] 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. diff --git a/docs/content/content/types.md b/docs/content/content/types.md index 54daafc31..5af0ef8b9 100644 --- a/docs/content/content/types.md +++ b/docs/content/content/types.md @@ -12,7 +12,7 @@ weight: 40 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 new -command through using content [archetypes](/content/archetypes). +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 @@ -20,7 +20,7 @@ rendered differently. ## Assigning a content type -Hugo assumes that your site will be organized into [sections](/content/sections) +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. @@ -32,7 +32,7 @@ Alternatively, you can set the type in the meta data under the key "`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). +[archetypes](/content/archetypes/). To create a new piece of content, use: @@ -73,4 +73,4 @@ that a template exists in each layouts/`TYPE` directory with the same name. 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). +More details about archetypes can be found at the [archetypes docs](/content/archetypes/). diff --git a/docs/content/extras/aliases.md b/docs/content/extras/aliases.md index 71150bd0a..adc7dc5da 100644 --- a/docs/content/extras/aliases.md +++ b/docs/content/extras/aliases.md @@ -22,16 +22,13 @@ Luckily, this can be handled easily with aliases in Hugo. **content/posts/my-awesome-blog-post.md** <table class="table"> +<thead> <tr> -<th>YAML</th><th>TOML</th> +<th>TOML</th><th>YAML</th> </tr> +</thead> +<tbody> <tr valign="top"> -<td><pre><code>--- -aliases: - - /posts/my-original-url/ - - /2010/even-earlier-url.html ---- -</code></pre></td> <td><pre><code>+++ aliases = [ "/posts/my-original-url/", @@ -39,7 +36,14 @@ aliases = [ ] +++ </code></pre></td> +<td><pre><code>--- +aliases: + - /posts/my-original-url/ + - /2010/even-earlier-url.html +--- +</code></pre></td> </tr> +</tbody> </table>< |