From 8fe78f6ff52496d4d3393495d6e598dceed15dda Mon Sep 17 00:00:00 2001 From: spf13 Date: Thu, 20 Feb 2014 19:05:09 -0500 Subject: [PATCH] A bunch of small documentation changes --- docs/content/content/example.md | 3 +-- docs/content/extras/highlighting.md | 22 +++++++++++----------- docs/content/layout/go-templates.md | 2 +- docs/content/layout/variables.md | 1 + docs/content/meta/release-notes.md | 6 +++--- docs/content/overview/introduction.md | 14 +++++++++++++- docs/layouts/_default/single.html | 3 +-- docs/layouts/index.html | 6 +++--- docs/static/static/css/styles.css | 9 +++++++-- 9 files changed, 41 insertions(+), 25 deletions(-) diff --git a/docs/content/content/example.md b/docs/content/content/example.md index d062150e..5ef6a372 100644 --- a/docs/content/content/example.md +++ b/docs/content/content/example.md @@ -15,8 +15,7 @@ Somethings are better shown than explained. The following is a very basic exampl {{% highlight yaml %}} --- Title: "Nitro : A quick and simple profiler for golang" -Description: "" -Keywords: [ "Development", "golang", "profiling" ] +Description: "Nitro is a simple profiler for you go lang applications" Tags: [ "Development", "golang", "profiling" ] date: "2013-06-19" Topics: [ "Development", "GoLang" ] diff --git a/docs/content/extras/highlighting.md b/docs/content/extras/highlighting.md index 57e9f5dc..6244a0cd 100644 --- a/docs/content/extras/highlighting.md +++ b/docs/content/extras/highlighting.md @@ -13,14 +13,14 @@ the path, it will silently simply pass the content along unhighlighted. ## Disclaimers - * **Warning** Pygments is relatively slow and our integration with it isn't + * **Warning** Pygments is relatively slow and our integration isn't speed optimized. Expect much longer build times when using highlighting - * The languages available depends on your pygments installation. + * Languages available depends on your pygments installation. * While pygments supports a few different output formats and options we currently only support output=html, style=monokai, noclasses=true, and encoding=utf-8. * Styles are inline in order to be supported in syndicated content when references to style sheets are not carried over. - * We have sought to have the simpliest interface possible, which consequently + * We have sought to have the simplest interface possible, which consequently limits configuration. An ambitious user is encouraged to extend the current functionality to offer more customization. @@ -46,13 +46,13 @@ closing shortcode. ## Example Output {{% highlight html %}} - <section id="main"> - <div> - <h1 id="title">{{ .Title }}</h1> - {{ range .Data.Pages }} - {{ .Render "summary"}} - {{ end }} - </div> - </section> +<section id="main"> + <div> + <h1 id="title">{{ .Title }}</h1> + {{ range .Data.Pages }} + {{ .Render "summary"}} + {{ end }} + </div> +</section> {{% /highlight %}} diff --git a/docs/content/layout/go-templates.md b/docs/content/layout/go-templates.md index b6a92b35..22c77713 100644 --- a/docs/content/layout/go-templates.md +++ b/docs/content/layout/go-templates.md @@ -163,7 +163,7 @@ The first example above could be simplified as: {{ with .Params.title }}

{{ . }}

{{ end }} -**Example 5: If -> Else If ** +**Example 5: If -> Else If** {{ if isset .Params "alt" }} {{ index .Params "alt" }} diff --git a/docs/content/layout/variables.md b/docs/content/layout/variables.md index 6dc8147c..d269c026 100644 --- a/docs/content/layout/variables.md +++ b/docs/content/layout/variables.md @@ -28,6 +28,7 @@ matter, content or derived from file location. **.LinkTitle** Access when creating links to this content. Will use linktitle if set in front-matter, else title
**.Indexes** These will use the field name of the plural form of the index (see tags and categories above)
**.RSSLink** Link to the indexes' rss link
+**.TableOfContents** The rendered table of contents for this content
**.Prev** Pointer to the previous content (based on pub date)
**.Next** Pointer to the following content (based on pub date)
**.FuzzyWordCount** The approximate number of words in the content.
diff --git a/docs/content/meta/release-notes.md b/docs/content/meta/release-notes.md index 1308e549..d6ba1fad 100644 --- a/docs/content/meta/release-notes.md +++ b/docs/content/meta/release-notes.md @@ -5,10 +5,10 @@ aliases: ["/doc/release-notes/"] groups: ["meta"] groups_weight: 10 --- -## **0.10.0** Feb 15, 2014 - * Syntax [highlighting](/extras/highlighting) powered by pygments (**slow**) +## **0.10.0** Feb 22, 2014 + * [Syntax highlighting](/extras/highlighting) powered by pygments (**slow**) * Ability to [sort content](/content/ordering) many more ways - * Automatic [table of contents](http://XXXXXXXXXXXXX) generation + * 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) diff --git a/docs/content/overview/introduction.md b/docs/content/overview/introduction.md index 93e18b4c..3c24fb14 100644 --- a/docs/content/overview/introduction.md +++ b/docs/content/overview/introduction.md @@ -63,6 +63,8 @@ Hugo boasts the following features: * ["Minutes to Read"](/layout/variables) functionality * ["Wordcount"](/layout/variables) functionality +See what's coming next in the [roadmap](/meta/roadmap) + ## Who should use Hugo? Hugo is for people that prefer writing in a text editor over @@ -82,7 +84,9 @@ I wrote Hugo ultimately for a few reasons. First I was disappointed with wordpress, my then website solution. It rendered slowly. I couldn't create content as efficiently as I wanted to and needed to be online to write posts. The constant security updates and the horror stories of people's -hacked blogs. +hacked blogs. I hated how content was written in HTML instead of the much +simpler markdown. Overall I felt like it got in my way more than it helped +my from writing great content. I looked at existing static site generators like Jekyll, Middle and Nanoc. All had complicated dependencies to install and took far longer to render @@ -97,3 +101,11 @@ dependencies. The Go language seemed to have all of the features I needed in a language. I began developing Hugo in Go and fell in love with the language. I hope you will enjoy using (and contributing to) Hugo as much 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) diff --git a/docs/layouts/_default/single.html b/docs/layouts/_default/single.html index c37b2883..aa93d4f0 100644 --- a/docs/layouts/_default/single.html +++ b/docs/layouts/_default/single.html @@ -1,6 +1,5 @@ {{ template "chrome/header.html" . }} - {{ if .Params.notoc }} - {{ else }} + {{ if not .Params.notoc }}
{{ .TableOfContents }}
diff --git a/docs/layouts/index.html b/docs/layouts/index.html index c086131a..952b6494 100755 --- a/docs/layouts/index.html +++ b/docs/layouts/index.html @@ -29,7 +29,7 @@ download
github - documentation + documentation @@ -192,7 +192,7 @@ Hugo is developed with love by spf13, Noah and friends. We welcome all contributions. New to go? Not a problem, we will help you. - Not a developer? Help with docs, templates and themes. + Not a developer? Help with docs, templates and themes.

@@ -208,7 +208,7 @@

Get Started Today!

Download - Documentation + Documentation
diff --git a/docs/static/static/css/styles.css b/docs/static/static/css/styles.css index c02f584e..f3ec584e 100755 --- a/docs/static/static/css/styles.css +++ b/docs/static/static/css/styles.css @@ -2,7 +2,12 @@ body { background-color: rgb(253, 253, 251); padding-top: 70px; letter-spacing: 0.3px; - font-family: 'Arbutus Slab', "Helvetica Neue", "Helvitica", "Serif"; + font-family: "Helvetica Neue", "Helvitica", "Serif"; + font-weight: 300; +} + +p { + margin: 0 0 2em; } #main.container { @@ -43,7 +48,7 @@ pre { } a { - color: rgb(96,210,211); + color: #2b91ae; } a:hover { -- 2.30.2