Skip to content

Commit 8ab362f

Browse files
committed
docs: update
Signed-off-by: Vishal Rana <[email protected]>
1 parent cd2530e commit 8ab362f

File tree

9 files changed

+69
-35
lines changed

9 files changed

+69
-35
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# [Echo] (https://echo.labstack.com) [![GoDoc](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)](http://godoc.org/github.com/labstack/echo) [![License](http://img.shields.io/badge/license-mit-blue.svg?style=flat-square)](https://raw.githubusercontent.com/labstack/echo/master/LICENSE) [![Build Status](http://img.shields.io/travis/labstack/echo.svg?style=flat-square)](https://travis-ci.org/labstack/echo) [![Coverage Status](http://img.shields.io/coveralls/labstack/echo.svg?style=flat-square)](https://coveralls.io/r/labstack/echo) [![Join the chat at https://gitter.im/labstack/echo](https://img.shields.io/badge/gitter-join%20chat-brightgreen.svg?style=flat-square)](https://gitter.im/labstack/echo) [![Twitter](https://img.shields.io/badge/[email protected]?style=flat-square)](https://twitter.com/labstack)
22

3-
### Fast and unfancy HTTP server framework for Go (Golang).
4-
53
## Feature Overview
64

75
- Optimized HTTP router which smartly prioritize routes
@@ -16,6 +14,7 @@
1614
- Define your format for the logger
1715
- Highly customizable
1816
- Automatic TLS via Let’s Encrypt
17+
- HTTP/2 support
1918
- Built-in graceful shutdown
2019

2120
## Performance

website/config.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"baseurl": "https://echo.labstack.com",
33
"languageCode": "en-us",
4-
"title": "Echo - Fast and unfancy HTTP server framework for Go (Golang)",
4+
"title": "Echo - Fast and Unfancy Go Web Framework",
55
"canonifyurls": true,
66
"googleAnalytics": "UA-85059636-2",
77
"permalinks": {
@@ -10,7 +10,6 @@
1010
"recipes": "/recipes/:filename"
1111
},
1212
"params": {
13-
"image": "https://echo.labstack.com/images/logo.png",
1413
"description": "Echo is a high performance, extensible, minimalist web framework for Go (Golang)."
1514
}
1615
}

website/content/guide.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,9 +200,9 @@ Server any file from static directory for path `/static/*`.
200200
e.Static("/static", "static")
201201
```
202202

203-
##### [Learn More](https://echo.labstack.com/guide/static-files)
203+
#### [Learn More](/guide/static-files)
204204

205-
### [Template Rendering](https://echo.labstack.com/guide/templates)
205+
### [Template Rendering](/guide/templates)
206206

207207
### Middleware
208208

@@ -231,3 +231,5 @@ e.GET("/users", func(c echo.Context) error {
231231
return c.String(http.StatusOK, "/users")
232232
}, track)
233233
```
234+
235+
#### [Learn More](/middleware)

website/content/guide/installation.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,32 @@ description = "Installing Echo"
77
weight = 1
88
+++
99

10-
Echo is developed and tested using Go `1.6.x` and `1.7.x`
10+
## Prerequisites
11+
12+
- [Install](https://golang.org/doc/install) Go
13+
- [Set](https://golang.org/doc/code.html#GOPATH) GOPATH
14+
15+
## Using [go get](https://golang.org/cmd/go/#hdr-Download_and_install_packages_and_dependencies)
1116

1217
```sh
18+
$ cd <project in $GOPATH>
1319
$ go get -u github.com/labstack/echo
1420
```
1521

16-
> Ideally you should rely on a [package manager](https://github.com/avelino/awesome-go#package-management) like glide or govendor to use a specific [version](https://github.com/labstack/echo/releases) of Echo.
22+
## Using [glide](http://glide.sh)
23+
24+
```sh
25+
$ cd <project in $GOPATH>
26+
$ glide get github.com/labstack/echo#~3.0
27+
```
28+
29+
## Using [govendor](https://github.com/kardianos/govendor)
1730

18-
## [Migrating Guide](/guide/migration)
31+
```sh
32+
$ cd <project in $GOPATH>
33+
$ govendor fetch github.com/labstack/[email protected]
34+
```
1935

20-
Echo follows [semantic versioning](http://semver.org) managed through GitHub releases.
21-
Specific version of Echo can be installed using a [package manager](https://github.com/avelino/awesome-go#package-management).
36+
Echo is developed using Go `1.7.x` and tested with Go `1.6.x` and `1.7.x`.
37+
Echo follows [semantic versioning](http://semver.org) managed through GitHub
38+
releases, specific version of Echo can be installed using a [package manager](https://github.com/avelino/awesome-go#package-management).

website/content/guide/testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,4 +156,4 @@ req, err := http.NewRequest(echo.POST, "/?"+q.Encode(), nil)
156156

157157
*TBD*
158158

159-
You can looking to built-in middleware [test cases](https://github.com/labstack/echo/tree/master/middleware).
159+
For now you can look into built-in middleware [test cases](https://github.com/labstack/echo/tree/master/middleware).

website/content/middleware/redirect.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description = "Redirect middleware for Echo"
77
weight = 5
88
+++
99

10-
## HTTPSRedirect Middleware
10+
## HTTPSRedirect
1111

1212
HTTPSRedirect middleware redirects http requests to https.
1313
For example, http://labstack.com will be redirected to https://labstack.com.
@@ -19,7 +19,7 @@ e := echo.New()
1919
e.Pre(middleware.HTTPSRedirect())
2020
```
2121

22-
## HTTPSWWWRedirect Middleware
22+
## HTTPSWWWRedirect
2323

2424
HTTPSWWWRedirect redirects http requests to www https.
2525
For example, http://labstack.com will be redirected to https://www.labstack.com.
@@ -31,7 +31,7 @@ e := echo.New()
3131
e.Pre(middleware.HTTPSWWWRedirect())
3232
```
3333

34-
## HTTPSNonWWWRedirect Middleware
34+
## HTTPSNonWWWRedirect
3535

3636
HTTPSNonWWWRedirect redirects http requests to https non www.
3737
For example, http://www.labstack.com will be redirect to https://labstack.com.
@@ -43,7 +43,7 @@ e := echo.New()
4343
e.Pre(middleware.HTTPSNonWWWRedirect())
4444
```
4545

46-
## WWWRedirect Middleware
46+
## WWWRedirect
4747

4848
WWWRedirect redirects non www requests to www.
4949

@@ -56,7 +56,7 @@ e := echo.New()
5656
e.Pre(middleware.WWWRedirect())
5757
```
5858

59-
## NonWWWRedirect Middleware
59+
## NonWWWRedirect
6060

6161
NonWWWRedirect redirects www requests to non www.
6262
For example, http://www.labstack.com will be redirected to http://labstack.com.

website/data/index.toml

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,44 @@
1-
h1 = "Echo"
2-
h2 = "High performance, extensible, minimalist web framework for Go"
1+
heading = "Echo"
2+
description = "High performance, extensible, minimalist Go web framework"
33
[[features]]
44
icon = "rocket"
55
title = "Optimized Router"
6-
text = "Highly optimized HTTP router which smartly prioritize routes"
6+
text = """
7+
Highly optimized HTTP router with zero dynamic memory allocation which smartly
8+
prioritize routes.
9+
"""
710
[[features]]
811
icon = "cloud"
9-
title = "RESTful API"
10-
text = "Build robust and scalable RESTful API"
12+
title = "Scalable"
13+
text = "Build robust and scalable RESTful API, easily organized into groups."
1114
[[features]]
1215
icon = "license"
1316
title = "Automatic TLS"
14-
text = "Automatically install TLS certificates from Let's Encrypt"
17+
text = "Automatically install TLS certificates from Let's Encrypt."
1518
[[features]]
1619
icon = "funnel"
17-
title = "Middleware Levels"
18-
text = "Define middleware at root, group or route level"
20+
title = "Middleware"
21+
text = """
22+
Many built-in middleware to use, or define your own. Middleware can be set at root,
23+
group or route level.
24+
"""
1925
[[features]]
20-
icon = "sync"
26+
icon = "database_upload"
2127
title = "Data Binding"
22-
text = "Data binding for JSON, XML and form payload"
28+
text = "Data binding for HTTP request payload, including JSON, XML or form-data."
29+
[[features]]
30+
icon = "database_download"
31+
title = "Data Rendering"
32+
text = """
33+
API to send variety of HTTP response, including JSON, XML, HTML, File, Attachment,
34+
Inline, Stream or Blob.
35+
"""
2336
[[features]]
2437
icon = "code"
2538
title = "Templates"
26-
text = "Template rendering with any template engine"
39+
text = "Template rendering using any template engine."
40+
[[features]]
41+
icon = "equalizer"
42+
title = "Extensible"
43+
text = "Customized central HTTP error handling. Easily extendable API."
2744

website/layouts/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
<div class="w3-row-padding">
1010
<div class="w3-col m10 l10">
1111
<div class="hero">
12-
<h1>{{ .Site.Data.index.h1 }}</h1>
13-
<h2>{{ .Site.Data.index.h2 }}</h2>
12+
<h1 class="heading">{{ .Site.Data.index.heading }}</h1>
13+
<h2 class="description">{{ .Site.Data.index.description }}</h2>
1414
<p>
1515
<img style="width: 100%;" src="/images/echo_terminal.png" alt="Echo">
1616
</p>

website/layouts/partials/head.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="x-ua-compatible" content="ie=edge">
6-
<meta name="description" content="{{ if ne .URL "/" }}{{ .Description }}{{ else }}{{ .Site.Params.description }}{{ end }}">
6+
<meta name="description" content="{{ if ne .URL "/" }}{{ .Description }} | {{ end }}{{ .Site.Params.description }}">
77
<meta name="viewport" content="width=device-width, initial-scale=1">
88
<meta name="twitter:card" content="summary">
99
<meta name="twitter:site" content="@echo">
1010
<meta name="twitter:title" content="{{ if ne .URL "/" }}{{ .Title }} | {{ end }}{{ .Site.Title }}">
11-
<meta name="twitter:description" content="{{ if ne .URL "/" }}{{ .Description }}{{ else }}{{ .Site.Params.description }}{{ end }}">
12-
<meta name="twitter:image" content="{{ .Site.Params.image }}">
11+
<meta name="twitter:description" content="{{ if ne .URL "/" }}{{ .Description }} | {{ end }}{{ .Site.Params.description }}">
12+
<meta name="twitter:image" content="{{ .Site.BaseURL }}/images/logo.png">
1313
<meta property="og:title" content="{{ if ne .URL "/" }}{{ .Title }} | {{ end }}{{ .Site.Title }}">
1414
<meta property="og:site_name" content="echo">
15-
<meta property="og:description" content="{{ if ne .URL "/" }}{{ .Description }}{{ else }}{{ .Site.Params.description }}{{ end }}">
15+
<meta property="og:description" content="{{ if ne .URL "/" }}{{ .Description }} | {{ end }}{{ .Site.Params.description }}">
1616
<meta property="og:url" content="{{ .Site.BaseURL }}">
17-
<meta property="og:image" content="{{ .Site.Params.image }}">
17+
<meta property="og:image" content="{{ .Site.BaseURL }}/images/logo.png">
1818
<title>
1919
{{ if ne .URL "/" }}{{ .Title }} | {{ end }}{{ .Site.Title }}
2020
</title>

0 commit comments

Comments
 (0)