Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Major Docs Patch #43

Merged
merged 106 commits into from Jan 7, 2015
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
106 commits
Select commit Hold shift + click to select a range
84779fe
pygments config changed to highlighter
pedromorgan Dec 27, 2014
e21a7fc
tidy up parts of the routing
pedromorgan Dec 28, 2014
c3f816b
tidy binding
pedromorgan Dec 30, 2014
c1484cf
tidy results
pedromorgan Dec 30, 2014
f63c368
tidy templates
pedromorgan Dec 30, 2014
e709213
tidy interceptors
pedromorgan Dec 30, 2014
6f70354
tidy cache.filters.sessionflash
pedromorgan Dec 31, 2014
1e2d933
tidy testing
pedromorgan Dec 31, 2014
783b2d8
tidy concepts and organization and links
pedromorgan Dec 31, 2014
df790b0
tidy messages, and loads of links
pedromorgan Dec 31, 2014
c7d2eaa
clean up samples, faq and validation
pedromorgan Dec 31, 2014
9a457c5
tidy samples and landing page
pedromorgan Dec 31, 2014
92f2ce1
reorder binding
pedromorgan Dec 31, 2014
8ccdae7
Am proud to announce the first commit of 2015.. the year for reveling…
pedromorgan Jan 1, 2015
53a729d
2015, the year I eat a lot of revels
pedromorgan Jan 1, 2015
8727f68
fix spelling/typo ..doh!
pedromorgan Jan 1, 2015
cb9eb24
fix some typos
pedromorgan Jan 1, 2015
ca126d8
remove whitespace
pedromorgan Jan 1, 2015
46a364c
minor fixes
pedromorgan Jan 1, 2015
a85c22a
minor fixes
pedromorgan Jan 1, 2015
722f734
minor fixes
pedromorgan Jan 1, 2015
2f9e1e4
tidy slashes
pedromorgan Jan 1, 2015
a2810ad
tidy hilight in messages and interceptors
pedromorgan Jan 1, 2015
338cf88
Fix bug #39
pedromorgan Jan 1, 2015
9aa0ebf
reverse route link
pedromorgan Jan 1, 2015
5382084
make template tags alphabetical
pedromorgan Jan 2, 2015
2e89da5
link to validation
pedromorgan Jan 2, 2015
7bbaa88
add link to github
pedromorgan Jan 2, 2015
0e56305
link datetime to formatting config
pedromorgan Jan 2, 2015
53c9d88
add amchors to appconf
pedromorgan Jan 2, 2015
41bdd11
tidy modules and filters
pedromorgan Jan 2, 2015
7d6243d
imporve page points to develop
pedromorgan Jan 2, 2015
5ca2fda
imporve page points to develop
pedromorgan Jan 2, 2015
0551f2a
template tags
pedromorgan Jan 2, 2015
6f2930d
dropdown menu for github
pedromorgan Jan 2, 2015
61d1d2e
strange stuff with prettyprint
pedromorgan Jan 2, 2015
f87d3df
strange stuff with prettyprint
pedromorgan Jan 2, 2015
55ddffe
cleanup css
pedromorgan Jan 2, 2015
3f6ef0f
bootstrap 3
pedromorgan Jan 2, 2015
117acb4
make layouts bootstrap3 and show experimental dropdown
pedromorgan Jan 2, 2015
329b0fa
try to tidy style
pedromorgan Jan 3, 2015
69fae4c
rename revel.css for cache
pedromorgan Jan 3, 2015
7957b1a
no pretty test
pedromorgan Jan 3, 2015
23a429c
no pretty test
pedromorgan Jan 3, 2015
4693062
try to make pygment nicer
pedromorgan Jan 3, 2015
3af42e0
nuke olde binary
pedromorgan Jan 3, 2015
fca347d
nuking pretty print
pedromorgan Jan 3, 2015
5d9a167
Adding footer include for later mod
pedromorgan Jan 3, 2015
151e257
tidy litte things
pedromorgan Jan 3, 2015
f499f68
various tiny fixes
pedromorgan Jan 3, 2015
221e1bf
tidy minor nicks
pedromorgan Jan 3, 2015
fecdd75
fix homepage layout
pedromorgan Jan 3, 2015
590c829
create links on homepage
pedromorgan Jan 3, 2015
febf703
fix quickstart
pedromorgan Jan 3, 2015
aa72e20
remove suplicate analytics
pedromorgan Jan 3, 2015
8252abf
try djano lexer
pedromorgan Jan 3, 2015
44a8084
try djano lexer
pedromorgan Jan 3, 2015
dd8640d
use htmldjango for templates.. and capture .. sighjekyll serve -d ../…
pedromorgan Jan 3, 2015
3fe44c5
highlight all other tempaltes
pedromorgan Jan 3, 2015
5ed7a1e
tidy some minor bits
pedromorgan Jan 3, 2015
7dd6264
tidy header styles
pedromorgan Jan 3, 2015
4b1726f
cleanup indentation
pedromorgan Jan 3, 2015
518aaa6
minor formatting
pedromorgan Jan 3, 2015
db9db61
make modules and urls a bit more sensible
pedromorgan Jan 3, 2015
f1eb1b4
tidy some formatting
pedromorgan Jan 3, 2015
495ad9f
tidy logging and deploy
pedromorgan Jan 3, 2015
0df89dc
am confused
pedromorgan Jan 3, 2015
153d007
am confused
pedromorgan Jan 3, 2015
e7f63ca
quick ref to cmd
pedromorgan Jan 3, 2015
a587311
still confused
pedromorgan Jan 3, 2015
070efaf
exise a load of named anchors
pedromorgan Jan 3, 2015
e38a319
tidy some little parts
pedromorgan Jan 3, 2015
f47b298
restore nuked binder.html
pedromorgan Jan 3, 2015
9aac094
database example
pedromorgan Jan 3, 2015
1c24509
database example
pedromorgan Jan 3, 2015
fac43f2
database example
pedromorgan Jan 3, 2015
fea98f0
add navigatin for godoc
pedromorgan Jan 3, 2015
01b556a
add links to godocs
pedromorgan Jan 3, 2015
3f79ad5
tidy up index.html
pedromorgan Jan 3, 2015
e28b56c
tidy up index.html
pedromorgan Jan 3, 2015
8e26255
add translations placeholder
pedromorgan Jan 3, 2015
ddc8ba9
add support menu
pedromorgan Jan 3, 2015
f878439
tidy concepts
pedromorgan Jan 3, 2015
949f1ce
tidy into
pedromorgan Jan 3, 2015
0fdb4e3
add links to godoc and issues
pedromorgan Jan 3, 2015
fe33323
more link to tags
pedromorgan Jan 3, 2015
bc5224e
fix cache error
pedromorgan Jan 3, 2015
194e0a8
fix contrib
pedromorgan Jan 3, 2015
980a3f5
minor fix of links
pedromorgan Jan 3, 2015
65665b7
minor fix of links
pedromorgan Jan 3, 2015
2836b34
add version data file
pedromorgan Jan 3, 2015
1c6bac6
add version data file
pedromorgan Jan 3, 2015
13c7c94
clean up some nit picks
pedromorgan Jan 4, 2015
f69b9af
tidy organisation
pedromorgan Jan 5, 2015
a3fc0ca
favicon
pedromorgan Jan 5, 2015
fad1b0c
favicon for moz
pedromorgan Jan 5, 2015
44ae446
add debug chapter
pedromorgan Jan 5, 2015
f641cd8
add disgus
pedromorgan Jan 5, 2015
d9520d4
add disgus
pedromorgan Jan 5, 2015
1e70638
tidy style, set section titles, revel debug
pedromorgan Jan 6, 2015
7e36ce2
customize homepage title
pedromorgan Jan 6, 2015
5f3eabb
tidy run mode and cmd
pedromorgan Jan 6, 2015
cc269f5
add faw re mailer
pedromorgan Jan 6, 2015
cfa56c8
add faw re mailer
pedromorgan Jan 6, 2015
e647c75
teaks and mailer
pedromorgan Jan 6, 2015
0fad2f7
add important deployment message
pedromorgan Jan 7, 2015
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
@@ -1 +1,2 @@
_site

4 changes: 3 additions & 1 deletion README.md
@@ -1,7 +1,9 @@
revel.github.io
===============

The jekyll site located at [revel.github.io](http://revel.github.io).
Documentation for the [Revel framework](https://github.com/revel/revel)

This [jekyll](http://jekyllrb.com/) powered site is located at [revel.github.io](http://revel.github.io).

To compile and view the site locally:

Expand Down
2 changes: 1 addition & 1 deletion _config.yml
@@ -1,4 +1,4 @@
safe: true
lsi: false
pygments: true
highlighter: pygments
markdown: kramdown
5 changes: 3 additions & 2 deletions _includes/head.html
@@ -1,8 +1,9 @@
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>{% if page.title %}{{ page.title }}{% else %}Revel{% endif %}</title>
<title>{% if page.title %}{{ page.title }}{% else %}Revel{% endif %} | Revel - a golang application framework</title>
<link href="{{ page.root }}/css/bootstrap.min.css" rel="stylesheet">
<link href="{{ page.root }}/css/journal.min.css" rel="stylesheet">
<link href="{{ page.root }}/css/revel.css" rel="stylesheet">
<link href="http://fonts.googleapis.com/css?family=Open+Sans:400italic,400,700" rel="stylesheet" type="text/css">
<link href="http://fonts.googleapis.com/css?family=Open+Sans:400italic,400,700" rel="stylesheet" type="text/css">

16 changes: 7 additions & 9 deletions _layouts/godoc.html
Expand Up @@ -4,21 +4,19 @@
<!DOCTYPE html>
<html>
<head>
{% include head.html %}
<link type="text/css" rel="stylesheet" href="{{ page.root }}/css/godoc.css">
<script type="text/javascript" src="{{ page.root }}/js/godoc.js"></script>
{% include analytics.html %}
{% include head.html %}
<link type="text/css" rel="stylesheet" href="{{ page.root }}/css/godoc.css">
<script type="text/javascript" src="{{ page.root }}/js/godoc.js"></script>
{% include analytics.html %}
</head>
<body>

{% include topnav.html %}

<div class="container">
<div id="page" class="span12">

{{content}}

</div>
<div id="page" class="span12">
{{content}}
</div>
</div>

</body>
Expand Down
17 changes: 9 additions & 8 deletions _layouts/manual.html
Expand Up @@ -21,16 +21,16 @@
title: Overview
url: controllers.html
-
title: Routing
title: URL Routing
url: routing.html
-
title: Parameters
url: binding.html
title: Request Parameters
url: paramaters.html
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: change "paramaters" to "parameters"

-
title: Validation
url: validation.html
-
title: Session / Flash
title: Session & Flash
url: sessionflash.html
-
title: Results
Expand All @@ -48,7 +48,7 @@
title: Websockets
url: websockets.html
-
title: I18n
title: Internationalization
url: i18n-messages.html
-
title: Cache
Expand Down Expand Up @@ -98,7 +98,8 @@
<link href="{{ page.root }}/css/prettify.css" type="text/css" rel="stylesheet" />
<script src="{{ page.root }}/js/prettify.js" type="text/javascript"></script>
<script src="{{ page.root }}/js/lang-go-rich.js" type="text/javascript"></script>
{% include analytics.html %}
<link href="{{ page.root }}/css/jekyll-github.css" type="text/css" rel="stylesheet" />
{% include analytics.html %}
</head>

<body onload="prettyPrint()">
Expand All @@ -107,11 +108,11 @@

<div class="container">
<div class="row">
<div class="span2">
<div class="span3">
{% include leftnav.html %}
</div>

<div class="span10">
<div class="span9">
<div class="page-header">
<h1>{{ page.title }}</h1>
<a href="https://github.com/revel/revel.github.io/edit/master/{{ page.path }}" class="improve-page btn btn-info" target="_blank">Improve this page</a>
Expand Down
8 changes: 6 additions & 2 deletions _layouts/samples.html
Expand Up @@ -17,6 +17,9 @@
-
title: Validation
url: validation.html
-
title: Upload
url: upload.html
-
title: Twitter OAuth
url: twitter-oauth.html
Expand All @@ -34,6 +37,7 @@
<link href="{{ page.root }}/css/prettify.css" type="text/css" rel="stylesheet" />
<script src="{{ page.root }}/js/prettify.js" type="text/javascript"></script>
<script src="{{ page.root }}/js/lang-go-rich.js" type="text/javascript"></script>
<link href="{{ page.root }}/css/jekyll-github.css" type="text/css" rel="stylesheet" />
{% include analytics.html %}
</head>

Expand All @@ -43,11 +47,11 @@

<div class="container">
<div class="row">
<div class="span2">
<div class="span3">
{% include leftnav.html %}
</div>

<div class="span10">
<div class="span9">
<div class="page-header">
<h1>{{ page.title }}</h1>
<a href="https://github.com/revel/revel.github.io/edit/master/{{ page.path }}" class="improve-page btn btn-info" target="_blank">Improve this page</a>
Expand Down
7 changes: 4 additions & 3 deletions _layouts/tutorial.html
Expand Up @@ -28,7 +28,8 @@
<link href="{{ page.root }}/css/prettify.css" type="text/css" rel="stylesheet" />
<script src="{{ page.root }}/js/prettify.js" type="text/javascript"></script>
<script src="{{ page.root }}/js/lang-go-rich.js" type="text/javascript"></script>
{% include analytics.html %}
<link href="{{ page.root }}/css/jekyll-github.css" type="text/css" rel="stylesheet" />
{% include analytics.html %}
</head>

<body onload="prettyPrint()">
Expand All @@ -37,11 +38,11 @@

<div class="container">
<div class="row">
<div class="span2">
<div class="span3">
{% include leftnav.html %}
</div>

<div class="span10">
<div class="span9">
<div class="page-header">
<h1>{{ page.title }}</h1>
<a href="https://github.com/revel/revel.github.io/edit/master/{{ page.path }}" class="improve-page btn btn-info" target="_blank">Improve this page</a>
Expand Down
68 changes: 68 additions & 0 deletions css/jekyll-github.css
@@ -0,0 +1,68 @@
/*
* GitHub style for Pygments syntax highlighter, for use with Jekyll
* Courtesy of GitHub.com
*/

.highlight pre, pre, .highlight .hll { background-color: #f8f8f8; border: 1px solid #ccc; padding: 6px 10px; border-radius: 3px; }
.highlight .c { color: #999988; font-style: italic; }
.highlight .err { color: #a61717; background-color: #e3d2d2; }
.highlight .k { font-weight: bold; }
.highlight .o { font-weight: bold; }
.highlight .cm { color: #999988; font-style: italic; }
.highlight .cp { color: #999999; font-weight: bold; }
.highlight .c1 { color: #999988; font-style: italic; }
.highlight .cs { color: #999999; font-weight: bold; font-style: italic; }
.highlight .gd { color: #000000; background-color: #ffdddd; }
.highlight .gd .x { color: #000000; background-color: #ffaaaa; }
.highlight .ge { font-style: italic; }
.highlight .gr { color: #aa0000; }
.highlight .gh { color: #999999; }
.highlight .gi { color: #000000; background-color: #ddffdd; }
.highlight .gi .x { color: #000000; background-color: #aaffaa; }
.highlight .go { color: #888888; }
.highlight .gp { color: #555555; }
.highlight .gs { font-weight: bold; }
.highlight .gu { color: #800080; font-weight: bold; }
.highlight .gt { color: #aa0000; }
.highlight .kc { font-weight: bold; }
.highlight .kd { font-weight: bold; }
.highlight .kn { font-weight: bold; }
.highlight .kp { font-weight: bold; }
.highlight .kr { font-weight: bold; }
.highlight .kt { color: #445588; font-weight: bold; }
.highlight .m { color: #009999; }
.highlight .s { color: #dd1144; }
.highlight .n { color: #333333; }
.highlight .na { color: teal; }
.highlight .nb { color: #0086b3; }
.highlight .nc { color: #445588; font-weight: bold; }
.highlight .no { color: teal; }
.highlight .ni { color: purple; }
.highlight .ne { color: #990000; font-weight: bold; }
.highlight .nf { color: #990000; font-weight: bold; }
.highlight .nn { color: #555555; }
.highlight .nt { color: navy; }
.highlight .nv { color: teal; }
.highlight .ow { font-weight: bold; }
.highlight .w { color: #bbbbbb; }
.highlight .mf { color: #009999; }
.highlight .mh { color: #009999; }
.highlight .mi { color: #009999; }
.highlight .mo { color: #009999; }
.highlight .sb { color: #dd1144; }
.highlight .sc { color: #dd1144; }
.highlight .sd { color: #dd1144; }
.highlight .s2 { color: #dd1144; }
.highlight .se { color: #dd1144; }
.highlight .sh { color: #dd1144; }
.highlight .si { color: #dd1144; }
.highlight .sx { color: #dd1144; }
.highlight .sr { color: #009926; }
.highlight .s1 { color: #dd1144; }
.highlight .ss { color: #990073; }
.highlight .bp { color: #999999; }
.highlight .vc { color: teal; }
.highlight .vg { color: teal; }
.highlight .vi { color: teal; }
.highlight .il { color: #009999; }
.highlight .gc { color: #999; background-color: #EAF2F5; }
24 changes: 24 additions & 0 deletions css/revel.css
Expand Up @@ -151,3 +151,27 @@ ul ul, ul ol, ol ol, ol ul, ul {
margin: 0 5px;
position: relative;
}

.container {
width: 1100px;
}

.leftnav {
border-right: 1px solid #dddddd;
}
.leftnav .nav-header {
background-color: #eeeeee;
border-top: 1px solid #dddddd;
padding-left: 2px;

}

.page-header {
border-bottom: 1px solid #dddddd;
}
.page-header h1 {
color: #222222;
font-family: sans-serif;
}


8 changes: 4 additions & 4 deletions index.html
Expand Up @@ -88,14 +88,14 @@ <h2>Synchronous</h2>
<h2>Stateless</h2>
<p>
Revel provides primitives that keep the web tier stateless for
predictable scaling. For example, session data is stored in the user
cookie, and the cache is backed by a memcached cluster.
predictable scaling. For example, <a href="manual/sessionflash.html#Session"><b>session</b></a> data is stored in the user
cookie, and the <a href="manual/cache.html"><b>cache</b></a> is backed by a memcached cluster, redis or in-memory.
</p>
</div>
<div class="span4">
<h2>Modular</h2>
<p>
Revel is built around composable middleware called <b>filters</b>,
Revel is built around composable middleware called <a href="manual/filters.html"><b>filters</b></a>,
which implement nearly all request-processing
functionality. Developers have the freedom to replace the default
filters with custom implementations (e.g. a custom router).
Expand All @@ -111,7 +111,7 @@ <h1>Quick Start</h1>
<div class="row">
<div class="span6">
<p>
Revel ships with sample applications to provide examples of
Revel ships with <a href="samples/">sample applications</a> to provide examples of
real-world usage.
</p>
<p>
Expand Down