phoenix/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-07-02 23:30:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

A bunch of small documentation changes

Browse source
This commit is contained in:
spf13 2014-02-20 19:05:09 -05:00
parent de05a0d942
commit 8fe78f6ff5
9 changed files with 41 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/content/content/example.md
View file

@ -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" ]

22
docs/content/extras/highlighting.md
View file

@ -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 %}}
<span style="color: #f92672">&lt;section</span> <span style="color: #a6e22e">id=</span><span style="color: #e6db74">&quot;main&quot;</span><span style="color: #f92672">&gt;</span>
<span style="color: #f92672">&lt;div&gt;</span>
<span style="color: #f92672">&lt;h1</span> <span style="color: #a6e22e">id=</span><span style="color: #e6db74">&quot;title&quot;</span><span style="color: #f92672">&gt;</span>{{ .Title }}<span style="color: #f92672">&lt;/h1&gt;</span>
{{ range .Data.Pages }}
{{ .Render &quot;summary&quot;}}
{{ end }}
<span style="color: #f92672">&lt;/div&gt;</span>
<span style="color: #f92672">&lt;/section&gt;</span>
<span style="color: #f92672">&lt;section</span> <span style="color: #a6e22e">id=</span><span style="color: #e6db74">&quot;main&quot;</span><span style="color: #f92672">&gt;</span>
<span style="color: #f92672">&lt;div&gt;</span>
<span style="color: #f92672">&lt;h1</span> <span style="color: #a6e22e">id=</span><span style="color: #e6db74">&quot;title&quot;</span><span style="color: #f92672">&gt;</span>{{ .Title }}<span style="color: #f92672">&lt;/h1&gt;</span>
{{ range .Data.Pages }}
{{ .Render &quot;summary&quot;}}
{{ end }}
<span style="color: #f92672">&lt;/div&gt;</span>
<span style="color: #f92672">&lt;/section&gt;</span>
{{% /highlight %}}

2
docs/content/layout/go-templates.md
View file

@ -163,7 +163,7 @@ The first example above could be simplified as:
{{ with .Params.title }}<h4>{{ . }}</h4>{{ end }}
**Example 5: If -> Else If **
**Example 5: If -> Else If**
{{ if isset .Params "alt" }}
{{ index .Params "alt" }}

1
docs/content/layout/variables.md
View file

@ -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<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>

6
docs/content/meta/release-notes.md
View file

@ -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)

14
docs/content/overview/introduction.md
View file

@ -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)

3
docs/layouts/_default/single.html
View file

@ -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>

6
docs/layouts/index.html
View file

@ -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>

9
docs/static/static/css/styles.css vendored
View file

@ -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 {