diff --git a/README.md b/README.md index e93897944..fd77853ed 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ and [friends](http://github.com/spf13/hugo/graphs/contributors) in Go. ## Overview -Hugo is a static site generator written in GoLang. It is optimized for +Hugo is a static site generator written in Go. It is optimized for speed, easy use and configurability. Hugo takes a directory with content and templates and renders them into a full html website. @@ -26,7 +26,7 @@ kind of website including blogs, tumbles and docs. ## Installing Hugo -Hugo is written in GoLang with support for Windows, Linux, FreeBSD and OSX. +Hugo is written in Go with support for Windows, Linux, FreeBSD and OSX. The latest release can be found at [hugo releases](https://github.com/spf13/hugo/releases). We currently build for Windows, Linux, FreeBSD and OS X for x64 @@ -43,7 +43,7 @@ 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. -*The Hugo executible has no external dependencies.* +*The Hugo executable has no external dependencies.* ### Installing from source diff --git a/docs/content/community/contributors.md b/docs/content/community/contributors.md index 0f5f9470e..1cc8b0cf4 100644 --- a/docs/content/community/contributors.md +++ b/docs/content/community/contributors.md @@ -7,7 +7,7 @@ groups_weight: 40 notoc: true --- -Hugo was built with love and golang by: +Hugo was built with love and Go by: * Steve Francia - [spf13](https://github.com/spf13) * Noah Campbell - [noahcampbell](https://github.com/noahcampbell) diff --git a/docs/content/content/example.md b/docs/content/content/example.md index 5ef6a372c..b012cd67d 100644 --- a/docs/content/content/example.md +++ b/docs/content/content/example.md @@ -14,22 +14,22 @@ Somethings are better shown than explained. The following is a very basic exampl {{% highlight yaml %}} --- -Title: "Nitro : A quick and simple profiler for golang" +Title: "Nitro : A quick and simple profiler for Go" Description: "Nitro is a simple profiler for you go lang applications" -Tags: [ "Development", "golang", "profiling" ] +Tags: [ "Development", "Go", "profiling" ] date: "2013-06-19" -Topics: [ "Development", "GoLang" ] +Topics: [ "Development", "Go" ] Slug: "nitro" project_url: "http://github.com/spf13/nitro" --- # Nitro -Quick and easy performance analyzer library for golang. +Quick and easy performance analyzer library for Go. ## Overview -Nitro is a quick and easy performance analyzer library for golang. +Nitro is a quick and easy performance analyzer library for Go. It is useful for comparing A/B against different drafts of functions or different functions. diff --git a/docs/content/indexes/category.md b/docs/content/indexes/category.md index 45a5e9b00..2240e8379 100644 --- a/docs/content/indexes/category.md +++ b/docs/content/indexes/category.md @@ -55,7 +55,7 @@ Make sure that the index is set in the front matter: "title": "Hugo: A fast and flexible static site generator", "categories": [ "Development", - "golang", + "Go", "Blogging" ], "slug": "hugo" diff --git a/docs/content/indexes/overview.md b/docs/content/indexes/overview.md index b72c1c5b6..43543a3e2 100644 --- a/docs/content/indexes/overview.md +++ b/docs/content/indexes/overview.md @@ -18,8 +18,8 @@ It's important to understand what Indexes do. At it's most basic form an index is simply a map of a key to a list of content values. In the hugo internals this is stored as `Site.Indexes[Plural][key][]pages`. -For example all the content tagged with GoLang would be found at -`Site.Indexes["tags"]["golang"]`. +For example all the content tagged with Go would be found at +`Site.Indexes["tags"]["Go"]`. For a more complete example see the source of [this docs site](http://github.com/spf13/hugo/docs/). @@ -65,7 +65,7 @@ and assign all keys you want this content to match against. "title": "Hugo: A fast and flexible static site generator", "tags": [ "Development", - "golang", + "Go", "fast", "Blogging" ], diff --git a/docs/content/layout/functions.md b/docs/content/layout/functions.md index c42d9e4c9..061c19ef8 100644 --- a/docs/content/layout/functions.md +++ b/docs/content/layout/functions.md @@ -6,7 +6,7 @@ groups: ["layout"] groups_weight: 70 --- -Hugo uses the excellent golang html/template library for its template engine. +Hugo uses the excellent go html/template library for its template engine. It is an extremely lightweight engine that provides a very small amount of logic. In our experience that it is just the right amount of logic to be able to create a good static website. @@ -14,7 +14,7 @@ to create a good static website. Go templates are lightweight but extensible. Hugo has added the following functions to the basic template logic. -Golang documentation for the built-in functions can be found [here](http://golang.org/pkg/text/template/) +Go documentation for the built-in functions can be found [here](http://golang.org/pkg/text/template/) ## General diff --git a/docs/content/layout/go-templates.md b/docs/content/layout/go-templates.md index 22c777131..d50e5858c 100644 --- a/docs/content/layout/go-templates.md +++ b/docs/content/layout/go-templates.md @@ -5,14 +5,14 @@ groups: ["layout"] groups_weight: 15 --- -Hugo uses the excellent [golang][] [html/template][gohtmltemplate] library for +Hugo uses the excellent [go][] [html/template][gohtmltemplate] library for its template engine. It is an extremely lightweight engine that provides a very small amount of logic. In our experience that it is just the right amount of logic to be able to create a good static website. If you have used other template systems from different languages or frameworks you will find a lot of similarities in go templates. -This document is a brief primer on using go templates. The [golang docs][gohtmltemplate] +This document is a brief primer on using go templates. The [go docs][gohtmltemplate] provide more details. ## Introduction to Go Templates @@ -23,7 +23,7 @@ One consequence of this simplicity is that go templates parse very quickly. A unique characteristic of go templates is they are content aware. Variables and content will be sanitized depending on the context of where they are used. More -details can be found in the [golang docs][gohtmltemplate]. +details can be found in the [go docs][gohtmltemplate]. ## Basic Syntax @@ -217,7 +217,7 @@ Could be rewritten as ## Context (aka. the dot) -The most easily overlooked concept to understand about golang templates is that {{ . }} +The most easily overlooked concept to understand about go templates is that {{ . }} always refers to the current context. In the top level of your template this will be the data set made available to it. Inside of a iteration it will have the value of the current item. When inside of a loop the context has changed. . @@ -329,5 +329,5 @@ so, such as in this example: ``` -[golang]: +[go]: [gohtmltemplate]: diff --git a/docs/content/layout/templates.md b/docs/content/layout/templates.md index 1c563e486..ca90d6120 100644 --- a/docs/content/layout/templates.md +++ b/docs/content/layout/templates.md @@ -7,7 +7,7 @@ groups: ["layout"] groups_weight: 10 --- -Hugo uses the excellent golang html/template library for its template engine. +Hugo uses the excellent go html/template library for its template engine. It is an extremely lightweight engine that provides a very small amount of logic. In our experience that it is just the right amount of logic to be able to create a good static website diff --git a/docs/content/overview/installing.md b/docs/content/overview/installing.md index caa8516a9..e80ace84f 100644 --- a/docs/content/overview/installing.md +++ b/docs/content/overview/installing.md @@ -6,7 +6,7 @@ groups: ['gettingStarted'] groups_weight: 20 --- -Hugo is written in GoLang with support for Windows, Linux, FreeBSD and OSX. +Hugo is written in Go with support for Windows, Linux, FreeBSD and OSX. The latest release can be found at [hugo releases](https://github.com/spf13/hugo/releases). We currently build for Windows, Linux, FreeBSD and OS X for x64 diff --git a/docs/content/tutorials/mathjax.md b/docs/content/tutorials/mathjax.md index d34157b6a..81f03b0ed 100644 --- a/docs/content/tutorials/mathjax.md +++ b/docs/content/tutorials/mathjax.md @@ -6,17 +6,11 @@ groups_weight: 10 author: "Spencer Lyon" --- - - ## What is MathJax? [MathJax](http://www.mathjax.org/) is a JavaScript library that allows allows the display of mathematical expressions described via a LaTeX-style syntax in the html (or markdown) source of a web page. As it is a pure a JavaScript library, getting it to work within Hugo is fairly straightforward, but does have some oddities that will be discussed here. -This is an introduction into actually using MathJax to render typeset mathematics on your website. Instead this page is a collection of tips and hints for one way to get MathJax working on a website built with Hugo. +This is not an introduction into actually using MathJax to render typeset mathematics on your website. Instead this page is a collection of tips and hints for one way to get MathJax working on a website built with Hugo. ## Enabling MathJax @@ -28,7 +22,7 @@ The first step is to enable MathJax on pages that you would like to have typeset {{% /highlight %}} -One way to ensure that this code is included in all pages is to put it in one of the templates that live in the `layouts/chrome/` directory. For example, I have included this in the bottom of my template `footer.html` because I know that the footer will be included in every page of my website. +One way to ensure that this code is included in all pages is to put it in one of the templates that live in the `layouts/chrome/` directory. For example, I have included this in the bottom of my template `footer.html` because I know that the footer will be included in every page of my website. ### Options and Features @@ -72,7 +66,7 @@ MathJax.Hub.Config({ {{% /highlight %}} -As before, this content should be included in the html source of each page that you would like to use +As before, this content should be included in the html source of each page that will be using MathJax. The next code snippet contains the CSS that is used to have verbatim MathJax blocks render with the same font style as the body of the page. {{% highlight css %}} @@ -83,8 +77,7 @@ code.has-jax {font: inherit; color: #515151;} {{% /highlight %}} -In the css snippet notice the line `color: #515151;`. This is the value assigned to the `color` attribute of the `body` class in my css. In order for the equations to look good on a particular website, this value should be updated to match the color of the text body for that page. - +In the css snippet notice the line `color: #515151;`. `#515151` is the value assigned to the `color` attribute of the `body` class in my css. In order for the equations to fit in with the body of a web page, this value should be the same as e color of the body. ### Usage diff --git a/docs/layouts/chrome/header.html b/docs/layouts/chrome/header.html index e0adaae9a..5fdcb5215 100644 --- a/docs/layouts/chrome/header.html +++ b/docs/layouts/chrome/header.html @@ -5,6 +5,8 @@ {{ template "chrome/includes.html" . }} + + diff --git a/docs/layouts/index.html b/docs/layouts/index.html index cd0ef01b1..63245579c 100755 --- a/docs/layouts/index.html +++ b/docs/layouts/index.html @@ -15,6 +15,8 @@ + + @@ -152,7 +154,7 @@

Finally someone builds me my own static site generator

— Hugo Rodger-Brown (@hugorodgerbrown) August 5, 2013

I'm loving the static site generator renaissance we are currently enjoying. Hugo is new, looks great, written in Go

— Jim Biancolo (@jimbiancolo) December 5, 2013

Good work on Hugo, I'm impressed with the speed!

— Ludovic Chabant (@ludovicchabant) December 6, 2013
-

Checking out Hugo; Loving it so far. Like Jekyll but not so blog-oriented and written in golang

— Jose Gonzalvo (@jgonzalvo) December 4, 2013
+

Checking out Hugo; Loving it so far. Like Jekyll but not so blog-oriented and written in go

— Jose Gonzalvo (@jgonzalvo) December 4, 2013
diff --git a/docs/static/static/share/hugo-tall.png b/docs/static/static/share/hugo-tall.png new file mode 100644 index 000000000..001ce5eb3 Binary files /dev/null and b/docs/static/static/share/hugo-tall.png differ diff --git a/docs/static/static/share/made-with-hugo-dark.png b/docs/static/static/share/made-with-hugo-dark.png new file mode 100644 index 000000000..c6cadf283 Binary files /dev/null and b/docs/static/static/share/made-with-hugo-dark.png differ diff --git a/docs/static/static/share/made-with-hugo-long-dark.png b/docs/static/static/share/made-with-hugo-long-dark.png new file mode 100644 index 000000000..1e49995fb Binary files /dev/null and b/docs/static/static/share/made-with-hugo-long-dark.png differ diff --git a/docs/static/static/share/made-with-hugo-long.png b/docs/static/static/share/made-with-hugo-long.png new file mode 100644 index 000000000..c5df534cf Binary files /dev/null and b/docs/static/static/share/made-with-hugo-long.png differ diff --git a/docs/static/static/share/made-with-hugo.png b/docs/static/static/share/made-with-hugo.png new file mode 100644 index 000000000..52dfd19e5 Binary files /dev/null and b/docs/static/static/share/made-with-hugo.png differ diff --git a/docs/static/static/share/powered-by-hugo-dark.png b/docs/static/static/share/powered-by-hugo-dark.png new file mode 100644 index 000000000..a8e2ebc80 Binary files /dev/null and b/docs/static/static/share/powered-by-hugo-dark.png differ diff --git a/docs/static/static/share/powered-by-hugo-long-dark.png b/docs/static/static/share/powered-by-hugo-long-dark.png new file mode 100644 index 000000000..1b760b1bf Binary files /dev/null and b/docs/static/static/share/powered-by-hugo-long-dark.png differ diff --git a/docs/static/static/share/powered-by-hugo-long.png b/docs/static/static/share/powered-by-hugo-long.png new file mode 100644 index 000000000..37131359d Binary files /dev/null and b/docs/static/static/share/powered-by-hugo-long.png differ diff --git a/docs/static/static/share/powered-by-hugo.png b/docs/static/static/share/powered-by-hugo.png new file mode 100644 index 000000000..27ff099d5 Binary files /dev/null and b/docs/static/static/share/powered-by-hugo.png differ diff --git a/hugolib/index.go b/hugolib/index.go index 30cb8f941..f87ca6035 100644 --- a/hugolib/index.go +++ b/hugolib/index.go @@ -28,7 +28,7 @@ type IndexList map[string]Index * An index is a map of keywords to a list of pages. * For example * TagIndex['technology'] = WeightedPages - * TagIndex['golang'] = WeightedPages2 + * TagIndex['go'] = WeightedPages2 */ type Index map[string]WeightedPages