Big visual overhaul of the docs. Docs now using indexes for all menu generation.

This commit is contained in:
spf13 2013-10-26 02:18:14 -04:00
parent df0523ff7f
commit 90355eec79
36 changed files with 1059 additions and 6875 deletions

View file

@ -2,6 +2,9 @@
title: "Example Content File"
date: "2013-07-01"
aliases: ["/doc/example/"]
linktitle: "Example"
groups: ['content']
groups_weight: 50
---
Somethings are better shown than explained. The following is a very basic example of a content file:

View file

@ -2,6 +2,8 @@
title = "Front Matter"
date = "2013-07-01"
aliases = ["/doc/front-matter/"]
groups = ["content"]
groups_weight = 40
+++
The front matter is one of the features that gives Hugo its strength. It enables

View file

@ -2,6 +2,9 @@
title: "Content Organization"
date: "2013-07-01"
aliases: ["/doc/organization/"]
linktitle: "Organization"
groups: ['content']
groups_weight: 10
---
Hugo uses markdown files with headers commonly called the front matter. Hugo respects the organization

View file

@ -1,6 +1,8 @@
---
title: "Sections"
date: "2013-07-01"
groups: ['content']
groups_weight: 20
---
Hugo thinks that you organize your content with a purpose. The same structure

View file

@ -1,6 +1,9 @@
---
title: "Content Types"
date: "2013-07-01"
linktitle: "Types"
groups: ['content']
groups_weight: 30
---
Hugo has full support for multiple content types each with its own set

View file

@ -5,6 +5,8 @@ aliases:
- /doc/redirects/
- /doc/alias/
- /doc/aliases/
groups: ["extras"]
groups_weight: 20
---
For people migrating existing published content to Hugo theres a good chance

View file

@ -2,6 +2,8 @@
title: "Indexes"
date: "2013-07-01"
aliases: ["/doc/indexes/"]
groups: ["extras"]
groups_weight: 30
---
Hugo includes support for user defined indexes of content. In our

View file

@ -1,6 +1,9 @@
---
title: "Index Category Example"
date: "2013-07-01"
linktitle: "Example - Categories"
groups: ["extras"]
groups_weight: 40
---
This page demonstrates an example of using indexes to provide categories for your site.

View file

@ -2,6 +2,8 @@
title: "Shortcodes"
date: "2013-07-01"
aliases: ["/doc/shortcodes/"]
groups: ["extras"]
groups_weight: 10
---
Because Hugo uses markdown for its content format, it was clear that there's a lot of things that

View file

@ -1,6 +1,8 @@
---
title: "Chrome Templates"
date: "2013-07-01"
groups: ["layout"]
groups_weight: 80
---
Chrome is a convention to create templates that are used by the other templates
throughout the site. There is nothing special about the name "chrome", feel free

View file

@ -1,6 +1,8 @@
---
title: "Go Templates"
date: "2013-07-01"
groups: ["layout---"]
groups_weight: 80
---
Hugo uses the excellent golang html/template library for its template engine.

View file

@ -1,6 +1,8 @@
---
title: "Homepage Templates"
date: "2013-07-01"
groups: ["layout"]
groups_weight: 30
---
Home pages are of the type "node" and have all the [node

View file

@ -1,6 +1,8 @@
---
title: "Index Templates"
date: "2013-07-01"
groups: ["layout"]
groups_weight: 50
---
An index template is any template that will be used to render multiple pieces of

View file

@ -1,6 +1,8 @@
---
title: "RSS (feed) Templates"
date: "2013-07-01"
groups: ["layout"]
groups_weight: 40
---
A single RSS template is used to generate all of the RSS content for the entire

View file

@ -2,6 +2,9 @@
title: "Templates"
date: "2013-07-01"
aliases: ["/doc/templates/"]
linktitle: "Overview"
groups: ["layout"]
groups_weight: 10
---
Hugo uses the excellent golang html/template library for its template engine.

View file

@ -2,6 +2,8 @@
title: "Variables"
date: "2013-07-01"
aliases: ["/doc/variables/"]
groups: ["layout"]
groups_weight: 20
---
Hugo makes a set of values available to the templates. Go templates are context based. The following

View file

@ -1,6 +1,8 @@
---
title: "Content Views"
date: "2013-07-01"
groups: ["layout"]
groups_weight: 70
---
In addition to the [single content view](/layout/content/), Hugo can render alternative views of

View file

@ -2,6 +2,8 @@
title: "Contributing to Hugo"
date: "2013-07-01"
aliases: ["/doc/contributing/"]
groups: ["meta"]
groups_weight: 30
---
We welcome all contributions. If you want to contribute, all

View file

@ -2,6 +2,8 @@
title: "Contributors"
date: "2013-07-01"
aliases: ["/doc/contributors/"]
groups: ["meta"]
groups_weight: 40
---
Hugo was built with love and golang by:

View file

@ -2,6 +2,8 @@
title: "License"
date: "2013-07-01"
aliases: ["/doc/license/", "/license/"]
groups: ["meta"]
groups_weight: 50
---
Hugo is released under the Simple Public License.

View file

@ -2,6 +2,8 @@
title: "Release Notes"
date: "2013-07-01"
aliases: ["/doc/release-notes/"]
groups: ["meta"]
groups_weight: 10
---
* **0.9.0** HEAD

View file

@ -2,6 +2,8 @@
title: "Roadmap"
date: "2013-07-01"
aliases: ["/doc/roadmap/"]
groups: ["meta"]
groups_weight: 20
---
In no particular order, here is what we are working on:
@ -10,8 +12,6 @@ In no particular order, here is what we are working on:
* Support for top level pages (other than homepage)
* Better error handling
* Syntax highlighting
* Commands
* Actions (eg. hugo create page)
* Related Posts
* Support for other formats

View file

@ -4,7 +4,7 @@ date: "2013-07-01"
aliases: ["/doc/configuration/"]
groups: ['gettingStarted']
linktitle: "Configuration"
groups_weight: 20
groups_weight: 40
---
The directory structure and templates provide the majority of the

View file

@ -3,7 +3,7 @@ title: "Installing Hugo"
date: "2013-07-01"
aliases: ["/doc/installing/"]
groups: ['gettingStarted']
groups_weight: 40
groups_weight: 20
---
Hugo is written in GoLang with support for Windows, Linux, FreeBSD and OSX.

View file

@ -3,7 +3,7 @@ title: "Hugo Quickstart Guide"
date: "2013-07-01"
groups: ['gettingStarted']
linktitle: "Quickstart"
groups_weight: 50
groups_weight: 10
---
## Step 1. Install Hugo

View file

@ -3,7 +3,7 @@ title: "Source Directory Organization"
date: "2013-07-01"
aliases: ["/doc/source-directory/"]
groups: ['gettingStarted']
groups_weight: 10
groups_weight: 50
---
Hugo takes a single directory and uses it as the input for creating a complete website.

View file

@ -1,15 +1,17 @@
</div>
</div>
<div id="ribbon">
<a href="http://github.com/spf13/hugo" rel="me">Fork me on GitHub</a>
</div>
</div>
<div class="container">
<hr>
<footer id="footer">
<p class="pull-right"><a href="#top">Back to top</a></p>
Made by <a href="http://spf13.com">Steve Francia</a>.<br>
Code licensed under the <a href="https://github.com/spf13/hugo/blob/master/LICENSE.md">Simple Public License 2.0</a>.<br>
</footer>
</div>
</div>
<script src="/static/js/jquery.js"></script>
<script src="/static/js/bootstrap.min.js"></script>
</body>
</html>

View file

@ -7,16 +7,9 @@
{{ template "chrome/includes.html" . }}
</head>
<body>
{{ template "chrome/menu.html" . }}
<div class="container">
<div class="row">
<div class="col-md-3 well" style="margin-top:1.8em;padding-top:0px;">
<div >
<h1><a href="/">Hugo</a></h1>
<p>A Fast and Flexible Static Site Generator
built with love by <a href="http://spf13.com">spf13</a> and <a
href="http://github.com/spf13/hugo/graphs/contributors">friends</a>
in Go</p>
</div>
{{ template "chrome/menu.html" . }}
</div>
<div class="col-md-9">
<div class="col-md-12">

View file

@ -1,2 +1,3 @@
<link href="/static/css/bootstrap.css" rel="stylesheet"/>
<link href="/static/css/bootstrap.min.css" rel="stylesheet"/>
<link href="/static/css/styles.css" rel="stylesheet"/>
<link href="/static/css/hugoicon.css" rel="stylesheet"/>

View file

@ -1,42 +1,62 @@
<ul class="nav nav-stacked nav-pills">
<li class="text-muted"><h4>Getting Started</h4></li>
<nav class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-ex1-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/"><i class="icon-rocket "></i>&nbsp; Hugo</a>
</div>
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse navbar-ex1-collapse">
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Getting Started <b class="caret"></b></a>
<ul class="dropdown-menu">
{{ range $key, $value := .Site.Indexes.groups.gettingstarted.Pages }}
<li hugo-nav="{{$value.RelPermalink}}"><a href="{{$value.Permalink}}"> {{ $value.LinkTitle }} </a> </li>
{{ end }}
<li class="divider"></li>
<li class="text-muted"><h4>Layout</h4></li>
<li> <a href="/layout/templates">Overview</a></li>
<li hugo-nav="/layout/variables"> <a href="/layout/variables">Variables</a></li>
<li hugo-nav="/layout/homepage"> <a href="/layout/homepage">Homepage</a></li>
<li hugo-nav="/layout/rss"> <a href="/layout/rss">RSS</a></li>
<li hugo-nav="/layout/indexes"> <a href="/layout/indexes">Index</a></li>
<li hugo-nav="/layout/content"> <a href="/layout/content">Content</a></li>
<li hugo-nav="/layout/views"> <a href="/layout/views">Content Views</a></li>
<li hugo-nav="/layout/chrome"> <a href="/layout/chrome">Chrome</a></li>
<li class="divider"></li>
<li class="text-muted"><h4>Content</h4></li>
<li hugo-nav="/content/organization"> <a href="/content/organization">Organization</a></li>
<li hugo-nav="/content/sections"> <a href="/content/sections">Sections</a></li>
<li hugo-nav="/content/types"> <a href="/content/types">Types</a></li>
<li hugo-nav="/content/front-matter"> <a href="/content/front-matter">Front Matter</a></li>
<li hugo-nav="/content/example"> <a href="/content/example">Example</a></li>
<li class="divider"></li>
<li class="text-muted"><h4>Extras</h4></li>
<li hugo-nav="/extras/shortcodes"> <a href="/extras/shortcodes">ShortCodes</a></li>
<li hugo-nav="/extras/aliases"> <a href="/extras/aliases">Aliases</a></li>
<li hugo-nav="/extras/indexes"> <a href="/extras/indexes">Indexes</a></li>
<li hugo-nav="/extras/indexes/category"> <a href="/extras/indexes/category">Example Index - Category</a></li>
<!--<li> <a href="/extras/indexes/series">Example Index - Series</a></li>-->
<li class="divider"></li>
<li class="text-muted"><h4>Meta</h4></li>
<li hugo-nav="/meta/release-notes"> <a href="/meta/release-notes">Release Notes</a></li>
<li hugo-nav="/meta/roadmap"> <a href="/meta/roadmap">Roadmap</a> </li>
<li hugo-nav="/meta/contributing"> <a href="/meta/contributing">Contributing</a></li>
<li hugo-nav="/meta/contributors"> <a href="/meta/contributors">Contributors</a></li>
<li hugo-nav="/meta/license"> <a href="/meta/license">License</a></li>
</ul>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Content <b class="caret"></b></a>
<ul class="dropdown-menu">
{{ range $key, $value := .Site.Indexes.groups.content.Pages }}
<li hugo-nav="{{$value.RelPermalink}}"><a href="{{$value.Permalink}}"> {{ $value.LinkTitle }} </a> </li>
{{ end }}
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Layout <b class="caret"></b></a>
<ul class="dropdown-menu">
{{ range $key, $value := .Site.Indexes.groups.layout.Pages }}
<li hugo-nav="{{$value.RelPermalink}}"><a href="{{$value.Permalink}}"> {{ $value.LinkTitle }} </a> </li>
{{ end }}
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Extras <b class="caret"></b></a>
<ul class="dropdown-menu">
{{ range $key, $value := .Site.Indexes.groups.extras.Pages }}
<li hugo-nav="{{$value.RelPermalink}}"><a href="{{$value.Permalink}}"> {{ $value.LinkTitle }} </a> </li>
{{ end }}
</ul>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Meta <b class="caret"></b></a>
<ul class="dropdown-menu">
{{ range $key, $value := .Site.Indexes.groups.meta.Pages }}
<li hugo-nav="{{$value.RelPermalink}}"><a href="{{$value.Permalink}}"> {{ $value.LinkTitle }} </a> </li>
{{ end }}
</ul>
</li>
<li><a href="http://github.com/spf13/hugo/releases"><i class="icon-arrow-down "> </i></a></li>
<li><a href="http://github.com/spf13/hugo"><i class="icon-octocat icon-2x"> </i></a></li>
</ul>
</div><!-- /.navbar-collapse -->
</nav>

View file

@ -9,7 +9,7 @@
<title>Hugo :: A fast and flexible static site generator</title>
<!-- Bootstrap core CSS -->
<link href="/static/css/bootstrap.css" rel="stylesheet">
<link href="/static/css/bootstrap.min.css" rel="stylesheet">
<!-- Add custom CSS here -->
<link href="/static/css/HPstyles.css" rel="stylesheet">
@ -25,7 +25,7 @@
<h3>The <em>Fast and Flexible</em> Static Site Generator</h3>
<br>
<a href="#intro" class="btn btn-clear btn-lg">LEARN MORE</a>&nbsp; &nbsp;
<a href="#download" class="btn btn-success btn-lg">DOWNLOAD <i class="icon-arrow-down"></i></a><br>
<a href="https://github.com/spf13/hugo/releases" class="btn btn-success btn-lg">DOWNLOAD <i class="icon-arrow-down"></i></a><br>
<br>
<a href="/overview/quickstart/" class="btn btn-info btn-lg">DOCUMENTATION</a>
</div>
@ -157,8 +157,8 @@
<div class="row">
<div class="col-md-6 col-md-offset-3 text-center">
<h3>Get Started Today!</h3>
<a href="#top" class="btn btn-md btn-default">Documentation</a>
<a href="#top" class="btn btn-lg btn-primary">Download <i class="icon-arrow-down"></i></a>
<a href="/overview/quickstart" class="btn btn-md btn-default">Documentation</a>
<a href="https://github.com/spf13/hugo/releases" class="btn btn-lg btn-primary">Download <i class="icon-arrow-down"></i></a>
</div>
</div>
</div>
@ -185,7 +185,8 @@
<!-- Bootstrap core JavaScript -->
<!-- Placed at the end of the document so the pages load faster -->
<script src="js/jquery.js"></script>
<script src="/static/js/jquery.js"></script>
<script src="/static/js/bootstrap.min.js"></script>
<script>
$(function() {

View file

@ -72,7 +72,7 @@ body {
}
.point {
background: #7fbbda;
background: rgb(22, 203, 230);
padding: 50px 0;
color: #ffffff;
}
@ -105,12 +105,12 @@ i.point-icon {
i.lead-icon:hover {
color: #fff;
border: 3px solid #7FBBDB;
background: #7FBBDB;
border: 3px solid black;
background: black;
}
i.point-icon:hover {
color: #7FBBDB;
color: rgb(22, 203, 230);
border: 3px solid #fff;
background: #fff;
}

File diff suppressed because it is too large Load diff

845
docs/static/static/css/bootstrap.min.css vendored Executable file

File diff suppressed because one or more lines are too long

View file

@ -1,9 +1,12 @@
body { padding-top: 70px; }
#ribbon {
background-color: #a00;
overflow: hidden;
position: absolute;
right: -3em;
top: 2.5em;
/*top: 2.5em;*/
top: 85px;
-moz-transform: rotate(45deg);
-webkit-transform: rotate(45deg);
-moz-box-shadow: 0 0 1em #888;
@ -20,3 +23,69 @@
text-decoration: none;
text-shadow: 0 0 0.5em #444;
}
body {
background-color: rgb(253, 253, 251);
}
h1, h2, h3 {
color: rgb(25,71,86);
}
a {
color: rgb(0,140,158);
}
a:hover {
color: rgb(21,201,239);
}
#footer {
margin-bottom: 2em;
}
nav.navbar {
background: none repeat scroll 0% 0% rgb(22, 203, 230);
border-top: 4px solid rgb(15, 166, 188);
border-bottom: 1px solid rgb(15, 166, 188);
opacity: .9;
}
.navbar-nav a > i {
font-size: 140%;
line-height: 49%;
vertical-align: -4px;
}
.navbar-inverse .navbar-nav > li > a, .navbar-inverse .navbar-brand {
color: white !important;
}
.navbar-inverse .navbar-nav > .dropdown > a .caret {
border-top-color: white;
border-bottom-color: white;
}
.dropdown-menu > li > a:hover, .dropdown-menu > li > a:focus {
text-decoration: none;
color: rgb(255, 255, 255);
background-color: rgb(15, 166, 188);
}
.navbar-inverse .navbar-nav > .open > a, .navbar-inverse .navbar-nav > .open > a:hover, .navbar-inverse .navbar-nav > .open > a:focus {
background-color: rgb(15, 166, 188);
}
.dropdown-menu > .active > a, .dropdown-menu > .active > a:hover, .dropdown-menu > .active > a:focus {
color: rgb(255, 255, 255);
text-decoration: none;
outline: 0px none;
background-color: rgb(15, 166, 188);
}
.navbar-inverse .navbar-toggle:hover, .navbar-inverse .navbar-toggle:focus {
background-color: rgb(15, 166, 188);
}
.navbar-inverse .navbar-toggle {
border-color: white;
}

11
docs/static/static/js/bootstrap.min.js vendored Executable file

File diff suppressed because one or more lines are too long