ref: 8fe78f6ff52496d4d3393495d6e598dceed15dda
parent: de05a0d942e79f59ebfed9f561e7f332a0b04504
author: spf13 <[email protected]>
date: Thu Feb 20 14:05:09 EST 2014
A bunch of small documentation changes
--- a/docs/content/content/example.md
+++ b/docs/content/content/example.md
@@ -15,8 +15,7 @@
{{% 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" ]
--- a/docs/content/extras/highlighting.md
+++ b/docs/content/extras/highlighting.md
@@ -13,14 +13,14 @@
## 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 @@
## Example Output
{{% highlight html %}}- <span style="color: #f92672"><section</span> <span style="color: #a6e22e">id=</span><span style="color: #e6db74">"main"</span><span style="color: #f92672">></span>
- <span style="color: #f92672"><div></span>
- <span style="color: #f92672"><h1</span> <span style="color: #a6e22e">id=</span><span style="color: #e6db74">"title"</span><span style="color: #f92672">></span>{{ .Title }}<span style="color: #f92672"></h1></span>- {{ range .Data.Pages }}- {{ .Render "summary"}}- {{ end }}- <span style="color: #f92672"></div></span>
- <span style="color: #f92672"></section></span>
+<span style="color: #f92672"><section</span> <span style="color: #a6e22e">id=</span><span style="color: #e6db74">"main"</span><span style="color: #f92672">></span>
+ <span style="color: #f92672"><div></span>
+ <span style="color: #f92672"><h1</span> <span style="color: #a6e22e">id=</span><span style="color: #e6db74">"title"</span><span style="color: #f92672">></span>{{ .Title }}<span style="color: #f92672"></h1></span>+ {{ range .Data.Pages }}+ {{ .Render "summary"}}+ {{ end }}+ <span style="color: #f92672"></div></span>
+<span style="color: #f92672"></section></span>
{{% /highlight %}}--- a/docs/content/layout/go-templates.md
+++ b/docs/content/layout/go-templates.md
@@ -163,7 +163,7 @@
{{ with .Params.title }}<h4>{{ . }}</h4>{{ end }}-**Example 5: If -> Else If **
+**Example 5: If -> Else If**
{{ if isset .Params "alt" }} {{ index .Params "alt" }}--- a/docs/content/layout/variables.md
+++ b/docs/content/layout/variables.md
@@ -28,6 +28,7 @@
**.LinkTitle** Access when creating links to this content. Will use linktitle if set in front-matter, else title<br>
**.Indexes** These will use the field name of the plural form of the index (see tags and categories above)<br>
**.RSSLink** Link to the indexes' rss link <br>
+**.TableOfContents** The rendered table of contents for this content<br>
**.Prev** Pointer to the previous content (based on pub date)<br>
**.Next** Pointer to the following content (based on pub date)<br>
**.FuzzyWordCount** The approximate number of words in the content.<br>
--- a/docs/content/meta/release-notes.md
+++ b/docs/content/meta/release-notes.md
@@ -5,10 +5,10 @@
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)
--- a/docs/content/overview/introduction.md
+++ b/docs/content/overview/introduction.md
@@ -63,6 +63,8 @@
* ["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 @@
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 @@
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)
--- 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 }}<div id="toc" class="well col-md-4 col-sm-6">
{{ .TableOfContents }}</div>
--- a/docs/layouts/index.html
+++ b/docs/layouts/index.html
@@ -29,7 +29,7 @@
<a href="https://github.com/spf13/hugo/releases" class="btn btn-success btn-lg">download <i class="icon-arrow-down"></i></a>
<br>
<a href="https://github.com/spf13/hugo" class="btn btn-dark btn-lg">github <i class="icon-circlestar"></i></a>
- <a href="/overview/quickstart/" class="btn btn-info btn-lg">documentation</a>
+ <a href="/overview/introduction" class="btn btn-info btn-lg">documentation</a>
</div>
</div>
<!-- /Full Page Image Header Area -->
@@ -192,7 +192,7 @@
Hugo is developed with love by <a href="http://spf13.com">spf13</a>, <a href="http://github.com/noahcampbell">Noah</a> and friends.
We welcome all contributions.
New to go? Not a problem, we will help you.
- Not a developer? Help with <a href="/overview/quickstart">docs</a>, templates and themes.
+ Not a developer? Help with <a href="/overview/introduction">docs</a>, templates and themes.
</p>
</div>
</div>
@@ -208,7 +208,7 @@
<div class="col-md-10 col-md-offset-1 text-center">
<h3>Get Started Today!</h3>
<a href="https://github.com/spf13/hugo/releases" class="btn btn-lg btn-primary">Download <i class="icon-arrow-down"></i></a>
- <a href="/overview/quickstart" style="color:white;font-weight:300;">Documentation</a>
+ <a href="/overview/introduction" style="color:white;font-weight:300;">Documentation</a>
</div>
</div>
</div>
--- a/docs/static/static/css/styles.css
+++ b/docs/static/static/css/styles.css
@@ -2,9 +2,14 @@
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 {
font-size: 21px;
line-height: 175%;
@@ -43,7 +48,7 @@
}
a {
- color: rgb(96,210,211);
+ color: #2b91ae;
}
a:hover {