diff --git a/README.md b/README.md index 142aecfc3..d36b5cb94 100644 --- a/README.md +++ b/README.md @@ -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. [![Build Status](https://travis-ci.org/spf13/hugo.png)](https://travis-ci.org/spf13/hugo) [![wercker status](https://app.wercker.com/status/1a0de7d703ce3b80527f00f675e1eb32 "wercker status")](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/).** [![Analytics](https://ga-beacon.appspot.com/UA-7131036-6/hugo/readme)](https://github.com/igrigorik/ga-beacon) [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/spf13/hugo/trend.png)](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 = "" - 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 <!--more--> 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 <!--more--> 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 type.md 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** + - + + + - + +
YAMLTOMLTOMLYAML 
---
-aliases:
-    - /posts/my-original-url/
-    - /2010/even-earlier-url.html
----
-
 
+++
 aliases = [
     "/posts/my-original-url/",
@@ -39,7 +36,14 @@ aliases = [
 ]
 +++
 
---
+aliases:
+    - /posts/my-original-url/
+    - /2010/even-earlier-url.html
+---
+
Now when you go to any of the aliases locations, they diff --git a/docs/content/extras/builders.md b/docs/content/extras/builders.md index 43b904cb2..e3af68e9b 100644 --- a/docs/content/extras/builders.md +++ b/docs/content/extras/builders.md @@ -24,7 +24,7 @@ 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 +places), [configuration](/overview/configuration/) and content are up to you... but luckily we have builders for content (see below). ## New Theme @@ -37,7 +37,7 @@ 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 +Follow the [Theme Creation Guide](/themes/creation/) once the builder is done. ## New Content @@ -45,7 +45,7 @@ done. 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 +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. diff --git a/docs/content/extras/comments.md b/docs/content/extras/comments.md index c1ac24da9..ade38aa44 100644 --- a/docs/content/extras/comments.md +++ b/docs/content/extras/comments.md @@ -14,7 +14,7 @@ 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 +Hugo ships with support for [Disqus](https://disqus.com/), a third-party service that provides comment and community capabilities to website via JavaScript. @@ -66,7 +66,7 @@ Users have noticed that enabling Disqus comments when running the Hugo web serve })(); -comments powered by Disqus +comments powered by Disqus ``` 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. @@ -78,17 +78,17 @@ Now, reference the partial template from your page template: # Alternatives -A few alternatives exist to [Disqus](https://disqus.com): +A few alternatives exist to [Disqus](https://disqus.com/): * [IntenseDebate](http://intensedebate.com/) * [Livefyre](http://livefyre.com/) -* [Muut](http://muut.com) +* [Muut](http://muut.com/) * [多说](http://duoshuo.com/) ([Duoshuo](http://duoshuo.com/), popular in China) -* [Kaiju](http://github.com/spf13/kaiju) +* [Kaiju](https://github.com/spf13/kaiju) -[Kaiju](http://github.com/spf13/kaiju) is an open-source project started -by [spf13](http://spf13.com) (Hugo’s author) to bring easy and fast real +[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 diff --git a/docs/content/extras/highlighting.md b/docs/content/extras/highlighting.md index fbc6b2ef5..5f226409f 100644 --- a/docs/content/extras/highlighting.md +++ b/docs/content/extras/highlighting.md @@ -20,7 +20,7 @@ it doesn’t cost anything when building your site and some of the highlighting scripts available cover more languages than Pygments does. For the pre-processed approach, Highlighting is performed by an external -Python-based program called [Pygments](http://pygments.org) and is triggered +Python-based program called [Pygments](http://pygments.org/) and is triggered via an embedded shortcode. If Pygments is absent from the path, it will silently simply pass the content along unhighlighted. diff --git a/docs/content/extras/menus.md b/docs/content/extras/menus.md index fcf90096f..c751f8326 100644 --- a/docs/content/extras/menus.md +++ b/docs/content/extras/menus.md @@ -87,7 +87,7 @@ available. ## 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). +content. This takes place in the sitewide [config file](/overview/configuration/). Here’s an example `config.toml`: diff --git a/docs/content/extras/pagination.md b/docs/content/extras/pagination.md index 03c3f8ec9..2b121b2ee 100644 --- a/docs/content/extras/pagination.md +++ b/docs/content/extras/pagination.md @@ -11,7 +11,7 @@ title: Pagination weight: 80 --- -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. +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 @@ -20,7 +20,7 @@ Pagination can be configured in the site configuration (e.g. `config.toml`): * `Paginate` (default `10`) * `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). +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/`. diff --git a/docs/content/extras/shortcodes.md b/docs/content/extras/shortcodes.md index be8258a97..8cf24c9c5 100644 --- a/docs/content/extras/shortcodes.md +++ b/docs/content/extras/shortcodes.md @@ -11,7 +11,7 @@ title: Shortcodes weight: 80 --- -Hugo uses Markdown for its simple content format. However, there’s a lot +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 @@ -25,7 +25,7 @@ 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. +want a [partial template](/templates/partials/) instead. ## Using a shortcode @@ -69,7 +69,7 @@ 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). +HTML. Read more on [highlighting](/extras/highlighting/). #### Usage `highlight` takes exactly one required parameter of _language_ and requires a diff --git a/docs/content/extras/toc.md b/docs/content/extras/toc.md index 7cd0f30f7..44d3411df 100644 --- a/docs/content/extras/toc.md +++ b/docs/content/extras/toc.md @@ -19,12 +19,12 @@ 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` +[content variable](/layout/variables/) `.TableOfContents` ## Template Example -This is example code of a [single.html template](/layout/content). +This is example code of a [single.html template](/layout/content/). {{ partial "header.html" . }}
diff --git a/docs/content/meta/release-notes.md b/docs/content/meta/release-notes.md index e38690c60..69a22e296 100644 --- a/docs/content/meta/release-notes.md +++ b/docs/content/meta/release-notes.md @@ -15,12 +15,12 @@ weight: 10 A lot has happened since Hugo v0.12.0 was released. * Changes to docs: - * A new [Troubleshooting](/troubleshooting/overview) section is added + * A new [Troubleshooting](/troubleshooting/overview/) section is added * It's now searchable through Google Custom Search ([#753][]) * Some new great tutorials: - * [Automated deployments with Wercker](/tutorials/automated-deployments) - * [Creating a new theme](/tutorials/creating-a-new-theme) -* Several improvements to the [template functions](/templates/functions): + * [Automated deployments with Wercker](/tutorials/automated-deployments/) + * [Creating a new theme](/tutorials/creating-a-new-theme/) +* 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: @@ -39,10 +39,10 @@ A lot has happened since Hugo v0.12.0 was released. * `GroupByPublishDate(format, order)` * `GroupByParam(key, order)` * `GroupByParamDate(key, format, order)` -* The [shortcode](/extras/shortcodes) handling is rewritten for speed and better error messages. Noticeable functional change is the distinction between `{{}}` (typically raw HTML) and `{{%/* */%}}` (Markdown) -* Support for [cross-references](/extras/crossreferences) -* 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 +* The [shortcode](/extras/shortcodes/) handling is rewritten for speed and better error messages. Noticeable functional change is the distinction between `{{}}` (typically raw HTML) and `{{%/* */%}}` (Markdown) +* Support for [cross-references](/extras/crossreferences/) +* 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 * 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» @@ -51,7 +51,7 @@ A lot has happened since Hugo v0.12.0 was released. * Improved unit test coverage * 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 * [Ace](http://ace.yoss.si/) template engine support ([#541][]) -* Add [pagination support](/extras/pagination) for home page, sections and taxonomies ([#750][]) +* Add [pagination support](/extras/pagination/) for home page, sections and taxonomies ([#750][]) * Fixed a lot of Windows-related path issues * Improved error messages for template and rendering errors * Enabled soft LiveReload of CSS and images ([#490][]) @@ -78,79 +78,79 @@ templates. This release represents over 90 code commits from 28 different contributors. * 10 [new themes](https://github.com/spf13/hugoThemes) created by the community - * Fully themable [Partials](/templates/partials) + * 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 + * [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) + * 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](http://github.com/spf13/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) + * [LiveReload](/extras/livereload/). Hugo will automatically reload the browser when the build is complete + * Theme engine w/[Theme Repository](https://github.com/spf13/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 + * 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) + * 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! + * [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/spf13/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 ./ ) + * New [command based interface](/overview/usage/) similar to git (`hugo server -s ./`) * Amber template support - * [Aliases](/extras/aliases) (redirects) + * [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) + * 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 (<!–more–>) - * HTML in [summary](/content/summaries) (when using divider) - * Added ["Minutes to Read"](/layout/variables) functionality + * Support for [summary](/content/summaries/) content divider (<!--more-->) + * 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 @@ -160,10 +160,10 @@ This release represents over 220 code commits from 22 different contributors. * 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) + * [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) + * 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 diff --git a/docs/content/overview/configuration.md b/docs/content/overview/configuration.md index c492296fc..ef677db63 100644 --- a/docs/content/overview/configuration.md +++ b/docs/content/overview/configuration.md @@ -132,9 +132,12 @@ but only these three. **Note** that these flags must be grouped under the `blackfriday` key and can be set on **both site and page level**. If set on page, it will override the site setting. Example: + + + - hardLineBreak +
TOMLYAML 
[blackfriday]
   angledQuotes = true
@@ -150,10 +153,11 @@ but only these three.
## Notes -Config changes are not reflected with [LiveReload](/extras/livereload). +Config changes are not reflected with [LiveReload](/extras/livereload/). Please restart `hugo server --watch` whenever you make a config change. diff --git a/docs/content/overview/installing.md b/docs/content/overview/installing.md index 671ca4208..0c9b69676 100644 --- a/docs/content/overview/installing.md +++ b/docs/content/overview/installing.md @@ -31,15 +31,15 @@ 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 OS X, if you have [Homebrew](http://brew.sh), installation is even +On OS X, if you have [Homebrew](http://brew.sh/), installation is even easier: just run `brew install hugo`. ### 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). +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 @@ -64,8 +64,12 @@ placed in your `PATH`. `go get` will then fetch Hugo and all its dependent libraries to your `$GOPATH/src` directory, and compile everything into the final `hugo` (or `hugo.exe`) executable, which you will find sitting in the -`$GOPATH/bin/hugo` directory, all ready to go! +`$GOPATH/bin/` directory, all ready to go! + +You may run `go get` with the `-u` option to update Hugo's dependencies: + + $ go get -u -v github.com/spf13/hugo ## Contributing -Please see the [contributing guide](/doc/contributing). +Please see the [contributing guide](/doc/contributing/). diff --git a/docs/content/overview/introduction.md b/docs/content/overview/introduction.md index cfa7f39df..a71611acf 100644 --- a/docs/content/overview/introduction.md +++ b/docs/content/overview/introduction.md @@ -52,43 +52,43 @@ Hugo boasts the following features: * Extremely fast build times (~1 ms per page) * Completely cross platform: Runs on  Mac OS X,  Linux,  Windows, and more! - * Easy [installation](/overview/installing) - * Render changes [on the fly](/overview/usage) with [LiveReload](/extras/livereload) as you develop + * 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](/indexes/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 + * 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) + * [Pretty URLs](/extras/urls/) support + * [Permalink](/extras/permalinks/) pattern support + * [Aliases](/extras/aliases/) (redirects) ### Content - * Content written in [Markdown](/content/example) - * 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 + * Content written in [Markdown](/content/example/) + * 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 - * Automatic [RSS](/layout/rss) creation + * Automatic [RSS](/layout/rss/) creation * Support for [Go](http://golang.org/pkg/html/template/), [Amber](https://github.com/eknkc/amber) and [Ace](http://ace.yoss.si/) HTML templates - * Syntax [highlighting](/extras/highlighting) powered by [Pygments](http://pygments.org/) + * Syntax [highlighting](/extras/highlighting/) powered by [Pygments](http://pygments.org/) -See what's coming next in the [roadmap](/meta/roadmap). +See what's coming next in the [roadmap](/meta/roadmap/). ## Who should use Hugo? @@ -135,9 +135,9 @@ as I have writing it. ## Next Steps - * [Install Hugo](/overview/installing) - * [Quick start](/overview/quickstart) - * [Join the Mailing List](/community/mailing-list) - * [Star us on GitHub](http://github.com/spf13/hugo) - * [Discussion Forum](http://discuss.gohugo.io) + * [Install Hugo](/overview/installing/) + * [Quick start](/overview/quickstart/) + * [Join the Mailing List](/community/mailing-list/) + * [Star us on GitHub](https://github.com/spf13/hugo) + * [Discussion Forum](http://discuss.gohugo.io/) diff --git a/docs/content/overview/quickstart.md b/docs/content/overview/quickstart.md index 0b1f292a7..ec4e9f308 100644 --- a/docs/content/overview/quickstart.md +++ b/docs/content/overview/quickstart.md @@ -135,7 +135,7 @@ Stop the Hugo process by hitting Ctrl+C. Then run the foll Web Server is available at http://localhost:1313 Press ctrl+c to stop -Open your [favorite editor](http://vim.spf13.com), edit and save your content, and watch as Hugo rebuilds and reloads automatically. +Open your [favorite editor](http://vim.spf13.com/), edit and save your content, and watch as Hugo rebuilds and reloads automatically. It’s especially productive to leave a browser open on a second monitor and just glance at it whenever you save. You don’t even need to tab to diff --git a/docs/content/overview/source-directory.md b/docs/content/overview/source-directory.md index 0c3db7f3e..fedfd0295 100644 --- a/docs/content/overview/source-directory.md +++ b/docs/content/overview/source-directory.md @@ -27,12 +27,12 @@ The top level of a source directory will typically have the following elements: Learn more about the different directories and what their purpose is: -* [config](/overview/configuration) -* [archetypes](/content/archetypes) -* [content](/content/organization) -* [layouts](/layout/overview) +* [config](/overview/configuration/) +* [archetypes](/content/archetypes/) +* [content](/content/organization/) +* [layouts](/layout/overview/) * [static](/themes/creation#toc_4) -* [themes](/themes/overview) +* [themes](/themes/overview/) ## Example diff --git a/docs/content/overview/usage.md b/docs/content/overview/usage.md index 1e7563aa6..8318d6f36 100644 --- a/docs/content/overview/usage.md +++ b/docs/content/overview/usage.md @@ -74,7 +74,7 @@ is saved. Press ctrl+c to stop Hugo can even run a server and create your site at the same time! Hugo -implements [LiveReload](/extras/livereload) technology to automatically reload any open pages in +implements [LiveReload](/extras/livereload/) technology to automatically reload any open pages in all browsers (including mobile). $ hugo server -ws ~/mysite diff --git a/docs/content/showcase/antzucaro.md b/docs/content/showcase/antzucaro.md index e51123c54..9c4f92f11 100644 --- a/docs/content/showcase/antzucaro.md +++ b/docs/content/showcase/antzucaro.md @@ -3,8 +3,8 @@ date: 2014-02-03T20:00:00Z description: Ant Zucaro's Blog license: GPL licenseLink: "" -sitelink: http://antzucaro.com -sourceLink: http://github.com/antzucaro/az.com +sitelink: http://antzucaro.com/ +sourceLink: https://github.com/antzucaro/az.com tags: - personal - blog diff --git a/docs/content/showcase/asc.md b/docs/content/showcase/asc.md index bf04f905b..9c9ebba94 100644 --- a/docs/content/showcase/asc.md +++ b/docs/content/showcase/asc.md @@ -3,7 +3,7 @@ date: 2014-01-22T07:32:00Z description: "" license: CC-BY-SA licenseLink: "" -sitelink: http://andrewcodispoti.com +sitelink: http://andrewcodispoti.com/ sourceLink: https://gitlab.com/acodispo/andrewcodispoti-com tags: - personal diff --git a/docs/content/showcase/chimera-art-space.md b/docs/content/showcase/chimera-art-space.md index cf0e00edd..ef1dd163c 100644 --- a/docs/content/showcase/chimera-art-space.md +++ b/docs/content/showcase/chimera-art-space.md @@ -3,7 +3,7 @@ date: 2013-10-02T07:32:00Z description: "" license: CC-SA licenseLink: "" -sitelink: http://chimeraarts.org +sitelink: http://chimeraarts.org/ sourceLink: https://github.com/chimera/chimeraarts.org tags: - company diff --git a/docs/content/showcase/cloudshark.md b/docs/content/showcase/cloudshark.md index 38f76df95..8fd2544da 100644 --- a/docs/content/showcase/cloudshark.md +++ b/docs/content/showcase/cloudshark.md @@ -3,7 +3,7 @@ date: 2014-03-27T09:45:00Z description: CloudShark Appliance homepage and documentation license: "" licenseLink: "" -sitelink: https://appliance.cloudshark.org +sitelink: https://appliance.cloudshark.org/ tags: - company - documentation diff --git a/docs/content/showcase/heyitsalex.md b/docs/content/showcase/heyitsalex.md index d27af3a87..b3c57c118 100644 --- a/docs/content/showcase/heyitsalex.md +++ b/docs/content/showcase/heyitsalex.md @@ -3,7 +3,7 @@ date: 2014-03-09T06:00:00Z description: "" license: MIT licenseLink: "" -sitelink: http://heyitsalex.net +sitelink: http://heyitsalex.net/ sourceLink: https://github.com/alexandre-normand/alexandre-normand tags: - personal diff --git a/docs/content/showcase/hugo.md b/docs/content/showcase/hugo.md index 77c05d4d3..2999279b8 100644 --- a/docs/content/showcase/hugo.md +++ b/docs/content/showcase/hugo.md @@ -3,8 +3,8 @@ date: 2013-07-01T07:32:00Z description: This site license: Simpl licenseLink: "" -sitelink: http://gohugo.io -sourceLink: http://github.com/spf13/hugo/tree/master/docs +sitelink: http://gohugo.io/ +sourceLink: https://github.com/spf13/hugo/tree/master/docs tags: - documentation - bootstrap diff --git a/docs/content/showcase/ifup.md b/docs/content/showcase/ifup.md index 59cf74efd..b964a33ab 100644 --- a/docs/content/showcase/ifup.md +++ b/docs/content/showcase/ifup.md @@ -3,8 +3,7 @@ date: 2013-11-02T07:32:00Z description: "" license: MIT licenseLink: "" -sitelink: http://ifup.org -sourceLink: http://www.ifup.org +sitelink: http://ifup.org/ tags: - personal - blog diff --git a/docs/content/showcase/kieranhealy.md b/docs/content/showcase/kieranhealy.md index bb8a852eb..c921cc5c0 100644 --- a/docs/content/showcase/kieranhealy.md +++ b/docs/content/showcase/kieranhealy.md @@ -3,8 +3,8 @@ date: 2014-02-27T20:35:00Z description: Kieran Healy's Website license: "" licenseLink: "" -sitelink: http://kieranhealy.org -sourceLink: http://github.com/kjhealy/kieranhealy.hugo +sitelink: http://kieranhealy.org/ +sourceLink: https://github.com/kjhealy/kieranhealy.hugo tags: - personal - blog diff --git a/docs/content/showcase/launchcode5.md b/docs/content/showcase/launchcode5.md index 6dfce5c44..70f21a4b2 100644 --- a/docs/content/showcase/launchcode5.md +++ b/docs/content/showcase/launchcode5.md @@ -3,7 +3,7 @@ date: 2014-11-01T07:32:00Z description: Corporate Site for Launchcode Software Studios license: Copyright Launchcode Software Studios licenseLink: "" -sitelink: http://www.launchcode5.com +sitelink: http://www.launchcode5.com/ sourceLink: https://github.com/Launchcode5/launchcode5.com tags: - bootstrap diff --git a/docs/content/showcase/npf.md b/docs/content/showcase/npf.md index d351b9e70..55745f59c 100644 --- a/docs/content/showcase/npf.md +++ b/docs/content/showcase/npf.md @@ -3,7 +3,7 @@ date: 2014-08-21T12:21:18-04:00 description: "" license: "" licenseLink: "" -sitelink: http://npf.io +sitelink: http://npf.io/ sourceLink: https://github.com/natefinch/npf tags: - personal diff --git a/docs/content/showcase/spf13.md b/docs/content/showcase/spf13.md index 1e2dc4230..d063bf67e 100644 --- a/docs/content/showcase/spf13.md +++ b/docs/content/showcase/spf13.md @@ -3,8 +3,8 @@ date: 2013-07-01T07:32:00Z description: The first Hugo powered website. license: MIT 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/content/showcase/stou.md b/docs/content/showcase/stou.md index 110c29420..c8808df44 100644 --- a/docs/content/showcase/stou.md +++ b/docs/content/showcase/stou.md @@ -3,8 +3,8 @@ date: 2014-11-23T01:28:16+07:00 description: "Rasmus Stougaard" license: "" licenseLink: "" -sitelink: http://stou.dk -sourceLink: "http://github.com/stou/stou.github.io" +sitelink: http://stou.dk/ +sourceLink: "https://github.com/stou/stou.github.io" tags: - personal - blog diff --git a/docs/content/showcase/techmadeplain.md b/docs/content/showcase/techmadeplain.md index b9f1005ae..3977fb97b 100644 --- a/docs/content/showcase/techmadeplain.md +++ b/docs/content/showcase/techmadeplain.md @@ -3,7 +3,7 @@ date: 2014-05-22T19:54:00Z description: Tech Coaching site license: "" licenseLink: "" -sitelink: http://techmadeplain.com +sitelink: http://techmadeplain.com/ tags: - personal - blog diff --git a/docs/content/showcase/thehome.md b/docs/content/showcase/thehome.md index 79e5bf054..a00710186 100644 --- a/docs/content/showcase/thehome.md +++ b/docs/content/showcase/thehome.md @@ -3,7 +3,7 @@ date: 2014-12-27T20:00:00+07:00 description: "Tom Helmer Hansen" license: "" licenseLink: "" -sitelink: http://www.thehome.dk +sitelink: http://www.thehome.dk/ sourceLink: "https://github.com/tomhelmer/website-source" tags: - personal diff --git a/docs/content/taxonomies/displaying.md b/docs/content/taxonomies/displaying.md index d5779ba3a..574d4dd1b 100644 --- a/docs/content/taxonomies/displaying.md +++ b/docs/content/taxonomies/displaying.md @@ -14,7 +14,7 @@ weight: 20 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): +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 diff --git a/docs/content/taxonomies/usage.md b/docs/content/taxonomies/usage.md index f55b865dc..3e8f6373f 100644 --- a/docs/content/taxonomies/usage.md +++ b/docs/content/taxonomies/usage.md @@ -48,7 +48,7 @@ and assign all terms you want to apply to this content. categories = [ "Development" ] series = [ "Go Web Dev" ] slug = "hugo" - project_url = "http://github.com/spf13/hugo" + project_url = "https://github.com/spf13/hugo" +++ ### Front Matter Example (in JSON) @@ -68,5 +68,5 @@ and assign all terms you want to apply to this content. "Go Web Dev" ], "slug": "hugo", - "project_url": "http://github.com/spf13/hugo" + "project_url": "https://github.com/spf13/hugo" } diff --git a/docs/content/templates/content.md b/docs/content/templates/content.md index 8b685a572..e4a9334a1 100644 --- a/docs/content/templates/content.md +++ b/docs/content/templates/content.md @@ -23,10 +23,10 @@ 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 +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` +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 provide, it will be used instead of `section`. @@ -62,8 +62,8 @@ same as the other types, but the directory must be called "\_default". ## post/single.html -This content template is used for [spf13.com](http://spf13.com). -It makes use of [partial templates](/layout/partials) +This content template is used for [spf13.com](http://spf13.com/). +It makes use of [partial templates](/layout/partials/) {{ partial "header.html" . }} {{ partial "subheader.html" . }} @@ -110,8 +110,8 @@ It makes use of [partial templates](/layout/partials) ## project/single.html -This content template is used for [spf13.com](http://spf13.com). -It makes use of [partial templates](/layout/partials) +This content template is used for [spf13.com](http://spf13.com/). +It makes use of [partial templates](/layout/partials/) {{ partial "header.html" . }} @@ -158,4 +158,4 @@ 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). +[content archetypes](/content/archetypes/). diff --git a/docs/content/templates/functions.md b/docs/content/templates/functions.md index d84d8ad39..ba9e54ba4 100644 --- a/docs/content/templates/functions.md +++ b/docs/content/templates/functions.md @@ -397,7 +397,7 @@ Converts the textual representation of the datetime into the other form or retur e.g. `{{ dateFormat "Monday, Jan 2, 2006" "2015-01-21" }}` →"Wednesday, Jan 21, 2015" ### highlight -Take a string of code and a language, uses Pygments to return the syntax highlighted code in HTML. Used in the [highlight shortcode](/extras/highlighting). +Take a string of code and a language, uses Pygments to return the syntax highlighted code in HTML. Used in the [highlight shortcode](/extras/highlighting/). ### ref, relref Looks up a content page by relative path or logical name to return the permalink (`ref`) or relative permalink (`relref`). Requires a Node or Page object (usually satisfied with `.`). Used in the [`ref` and `relref` shortcodes]({{% ref "extras/crossreferences.md" %}}). diff --git a/docs/content/templates/go-templates.md b/docs/content/templates/go-templates.md index b2ce192b7..fb05282bd 100644 --- a/docs/content/templates/go-templates.md +++ b/docs/content/templates/go-templates.md @@ -65,7 +65,7 @@ Accessing the Page Parameter "bar" Each Go template has a struct (object) made available to it. In Hugo, each template is passed either a page or a node struct depending on which type of page you are rendering. More details are available on the -[variables](/layout/variables) page. +[variables](/layout/variables/) page. A variable is accessed by referencing the variable name. @@ -82,7 +82,7 @@ Variables can also be defined and referenced. 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 +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. @@ -303,7 +303,7 @@ 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). +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 diff --git a/docs/content/templates/homepage.md b/docs/content/templates/homepage.md index f4dfc763f..412857ce0 100644 --- a/docs/content/templates/homepage.md +++ b/docs/content/templates/homepage.md @@ -45,9 +45,9 @@ the list will be needed. * /themes/`THEME`/layouts/\_default/single.html ## Example index.html -This content template is used for [spf13.com](http://spf13.com). +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/). +It makes use of [partial templates](/templates/partials/) and uses a similar approach as a [List](/templates/list/). diff --git a/docs/content/templates/list.md b/docs/content/templates/list.md index d23e312e0..e39abbd17 100644 --- a/docs/content/templates/list.md +++ b/docs/content/templates/list.md @@ -13,7 +13,7 @@ weight: 40 --- 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 +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 @@ -102,8 +102,8 @@ Taxonomy pages will additionally have: ## 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 +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. @@ -124,8 +124,8 @@ defined. {{ 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 +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. @@ -146,7 +146,7 @@ defined. ## 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. +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: diff --git a/docs/content/templates/overview.md b/docs/content/templates/overview.md index d0eabb55c..f875e7299 100644 --- a/docs/content/templates/overview.md +++ b/docs/content/templates/overview.md @@ -23,23 +23,23 @@ 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) +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) +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 +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) +### [Single](/templates/content/) Render a single piece of content -### [List](/templates/list) +### [List](/templates/list/) Page that list multiple pieces of content ### [Homepage](/templates/homepage/) @@ -49,13 +49,13 @@ The homepage of your site Hugo also has additional kinds of templates all of which are optional -### [Partial Templates](/templates/partials) +### [Partial Templates](/templates/partials/) Common page parts to be included in the above mentioned templates -### [Content Views](/templates/views) +### [Content Views](/templates/views/) Different ways of rendering a (single) content type -### [Taxonomy Terms](/templates/terms) +### [Taxonomy Terms](/templates/terms/) A list of the terms used for a specific taxonomy, e.g. a Tag cloud ## Other Templates (generally unnecessary) @@ -66,7 +66,7 @@ Used to render all rss documents ### [Sitemap](/templates/sitemap/) Used to render the XML sitemap -### [404](/templates/404) +### [404](/templates/404/) This template will create a 404.html page used when hosting on GitHub Pages diff --git a/docs/content/templates/partials.md b/docs/content/templates/partials.md index e5a418647..fc9c46274 100644 --- a/docs/content/templates/partials.md +++ b/docs/content/templates/partials.md @@ -51,7 +51,7 @@ the “partial/” path). The old approach would still work, but wouldn’t bene 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): +This header template is used for [spf13.com](http://spf13.com/): @@ -70,7 +70,7 @@ This header template is used for [spf13.com](http://spf13.com): ## Example footer.html -This footer template is used for [spf13.com](http://spf13.com): +This footer template is used for [spf13.com](http://spf13.com/):
@@ -219,7 +219,7 @@

Getting Started

Download - Quickstart Guide + Quickstart Guide

 

Using Homebrew?

brew install hugo
@@ -235,8 +235,8 @@
    -
    • -
    • +
    • +

Copyright © Steve Francia 2013–2015

diff --git a/docs/layouts/partials/footer.html b/docs/layouts/partials/footer.html index 39300434f..f42637593 100644 --- a/docs/layouts/partials/footer.html +++ b/docs/layouts/partials/footer.html @@ -1,4 +1,5 @@ - +
+
Hugo v{{ .Hugo.Version }} documentation
diff --git a/docs/layouts/partials/header.html b/docs/layouts/partials/header.html index 31196dc96..8da301198 100644 --- a/docs/layouts/partials/header.html +++ b/docs/layouts/partials/header.html @@ -3,9 +3,9 @@ - - - + + {{ with .Site.Params.author }}{{ end }} + {{ .Hugo.Generator }} {{.Title}} @@ -30,7 +30,7 @@
- +
diff --git a/hugolib/redis.cn.md b/hugolib/redis.cn.md index 0daa7f493..d485061d5 100644 --- a/hugolib/redis.cn.md +++ b/hugolib/redis.cn.md @@ -41,7 +41,7 @@ Karl之前还写了[《The Little MongoDB Book》](http://openmymind.net/2011/3/ ### 最新版本 此书的最新有效资源在： - + 中文版是英文版的一个分支，最新的中文版本在：