mirror of
https://github.com/kataras/iris.git
synced 2025-01-23 02:31:04 +01:00
Fix sidebar links (1)
Makis Maropoulos
parent
8770115a62
commit
116ea1c47c
88
Home.md
88
Home.md
|
|
@ -1,48 +1,48 @@
|
|||
# Summary
|
||||
|
||||
* [Introduction](README.md)
|
||||
* [Features](features.md)
|
||||
* [Versioning](versioning.md)
|
||||
* [Install](install.md)
|
||||
* [Hi](hi.md)
|
||||
* [Transport Layer Security](tls.md)
|
||||
* [Handlers](handlers.md)
|
||||
* [Using Handlers](using-handlers.md)
|
||||
* [Using HandlerFuncs](using-handlerfuncs.md)
|
||||
* [Using Annotated](using-annotated.md)
|
||||
* [Using native http.Handler](using-native-httphandler.md)
|
||||
* [Using native http.Handler via iris.ToHandlerFunc()](using-native-httphandler-via-tohandlerfunc.md)
|
||||
* [Middlewares](middlewares.md)
|
||||
* [API](api.md)
|
||||
* [Declaration](declaration.md)
|
||||
* [Configuration](configuration.md)
|
||||
* [Party](party.md)
|
||||
* [Subdomains](subdomains.md)
|
||||
* [Named Parameters](named-parameters.md)
|
||||
* [Static files](static-files.md)
|
||||
* [Send files](send-files.md)
|
||||
* [Render](render.md)
|
||||
* [REST](render_rest.md)
|
||||
* [Templates](render_templates.md)
|
||||
* [Gzip](gzip.md)
|
||||
* [Streaming](streaming.md)
|
||||
* [Cookies](cookies.md)
|
||||
* [Flash messages](flashmessages.md)
|
||||
* [Body binder](request-body-bind.md)
|
||||
* [Custom HTTP Errors](custom-http-errors.md)
|
||||
* [Context](context.md)
|
||||
* [Logger](logger.md)
|
||||
* [HTTP access control](middleware-cors.md)
|
||||
* [Secure](middleware-secure.md)
|
||||
* [Sessions](package-sessions.md)
|
||||
* [Websockets](package-websocket.md)
|
||||
* [Graceful](package-graceful.md)
|
||||
* [Recovery](middleware-recovery.md)
|
||||
* [Plugins](plugins.md)
|
||||
* [Internationalization and Localization](middleware-internationalization-and-localization.md)
|
||||
* [Easy Typescript](plugin-typescript.md)
|
||||
* [Browser based Editor](plugin-editor.md)
|
||||
* [Routes info](plugin-routesinfo.md)
|
||||
* [Control panel](plugin-iriscontrol.md)
|
||||
* [Introduction](README)
|
||||
* [Features](features)
|
||||
* [Versioning](versioning)
|
||||
* [Install](install)
|
||||
* [Hi](hi)
|
||||
* [Transport Layer Security](tls)
|
||||
* [Handlers](handlers)
|
||||
* [Using Handlers](using-handlers)
|
||||
* [Using HandlerFuncs](using-handlerfuncs)
|
||||
* [Using Annotated](using-annotated)
|
||||
* [Using native http.Handler](using-native-httphandler)
|
||||
* [Using native http.Handler via iris.ToHandlerFunc()](using-native-httphandler-via-tohandlerfunc)
|
||||
* [Middlewares](middlewares)
|
||||
* [API](api)
|
||||
* [Declaration](declaration)
|
||||
* [Configuration](configuration)
|
||||
* [Party](party)
|
||||
* [Subdomains](subdomains)
|
||||
* [Named Parameters](named-parameters)
|
||||
* [Static files](static-files)
|
||||
* [Send files](send-files)
|
||||
* [Render](render)
|
||||
* [REST](render_rest)
|
||||
* [Templates](render_templates)
|
||||
* [Gzip](gzip)
|
||||
* [Streaming](streaming)
|
||||
* [Cookies](cookies)
|
||||
* [Flash messages](flashmessages)
|
||||
* [Body binder](request-body-bind)
|
||||
* [Custom HTTP Errors](custom-http-errors)
|
||||
* [Context](context)
|
||||
* [Logger](logger)
|
||||
* [HTTP access control](middleware-cors)
|
||||
* [Secure](middleware-secure)
|
||||
* [Sessions](package-sessions)
|
||||
* [Websockets](package-websocket)
|
||||
* [Graceful](package-graceful)
|
||||
* [Recovery](middleware-recovery)
|
||||
* [Plugins](plugins)
|
||||
* [Internationalization and Localization](middleware-internationalization-and-localization)
|
||||
* [Easy Typescript](plugin-typescript)
|
||||
* [Browser based Editor](plugin-editor)
|
||||
* [Routes info](plugin-routesinfo)
|
||||
* [Control panel](plugin-iriscontrol)
|
||||
* [Examples](https://github.com/iris-contrib/examples)
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ this will update the dependencies also.
|
|||
|
||||
If you are connected to the Internet through **China**, according to [this](https://github.com/kataras/iris/issues/98) you will be have problem downloading the golang/x/net/context. **Follow the below steps**:
|
||||
|
||||
1. https://github.com/northbright/Notes/blob/master/Golang/china/get-golang-packages-on-golang-org-in-china.md
|
||||
1. https://github.com/northbright/Notes/blob/master/Golang/china/get-golang-packages-on-golang-org-in-china
|
||||
|
||||
2. `$ go get github.com/kataras/iris ` **without -u**
|
||||
|
||||
|
|
|
|||
84
README.md
84
README.md
|
|
@ -3,48 +3,48 @@
|
|||
|
||||
## Table of Contents
|
||||
|
||||
* [Introduction](README.md)
|
||||
* [Features](features.md)
|
||||
* [Versioning](versioning.md)
|
||||
* [Install](install.md)
|
||||
* [Hi](hi.md)
|
||||
* [Transport Layer Security](tls.md)
|
||||
* [Handlers](handlers.md)
|
||||
* [Using Handlers](using-handlers.md)
|
||||
* [Using HandlerFuncs](using-handlerfuncs.md)
|
||||
* [Using Annotated](using-annotated.md)
|
||||
* [Using native http.Handler](using-native-httphandler.md)
|
||||
* [Using native http.Handler via iris.ToHandlerFunc()](using-native-httphandler-via-tohandlerfunc.md)
|
||||
* [Middlewares](middlewares.md)
|
||||
* [API](api.md)
|
||||
* [Declaration](declaration.md)
|
||||
* [Configuration](configuration.md)
|
||||
* [Party](party.md)
|
||||
* [Subdomains](subdomains.md)
|
||||
* [Named Parameters](named-parameters.md)
|
||||
* [Static files](static-files.md)
|
||||
* [Send files](send-files.md)
|
||||
* [Render](render.md)
|
||||
* [Gzip](gzip.md)
|
||||
* [Streaming](streaming.md)
|
||||
* [Cookies](cookies.md)
|
||||
* [Flash messages](flashmessages.md)
|
||||
* [Body binder](request-body-bind.md)
|
||||
* [Custom HTTP Errors](custom-http-errors.md)
|
||||
* [Context](context.md)
|
||||
* [Logger](logger.md)
|
||||
* [HTTP access control](middleware-cors.md)
|
||||
* [Secure](middleware-secure.md)
|
||||
* [Sessions](package-sessions.md)
|
||||
* [Websockets](package-websocket.md)
|
||||
* [Graceful](package-graceful.md)
|
||||
* [Recovery](middleware-recovery.md)
|
||||
* [Plugins](plugins.md)
|
||||
* [Internationalization and Localization](middleware-internationalization-and-localization.md)
|
||||
* [Easy Typescript](plugin-typescript.md)
|
||||
* [Browser based Editor](plugin-editor.md)
|
||||
* [Routes info](plugin-routesinfo.md)
|
||||
* [Control panel](plugin-iriscontrol.md)
|
||||
* [Introduction](README)
|
||||
* [Features](features)
|
||||
* [Versioning](versioning)
|
||||
* [Install](install)
|
||||
* [Hi](hi)
|
||||
* [Transport Layer Security](tls)
|
||||
* [Handlers](handlers)
|
||||
* [Using Handlers](using-handlers)
|
||||
* [Using HandlerFuncs](using-handlerfuncs)
|
||||
* [Using Annotated](using-annotated)
|
||||
* [Using native http.Handler](using-native-httphandler)
|
||||
* [Using native http.Handler via iris.ToHandlerFunc()](using-native-httphandler-via-tohandlerfunc)
|
||||
* [Middlewares](middlewares)
|
||||
* [API](api)
|
||||
* [Declaration](declaration)
|
||||
* [Configuration](configuration)
|
||||
* [Party](party)
|
||||
* [Subdomains](subdomains)
|
||||
* [Named Parameters](named-parameters)
|
||||
* [Static files](static-files)
|
||||
* [Send files](send-files)
|
||||
* [Render](render)
|
||||
* [Gzip](gzip)
|
||||
* [Streaming](streaming)
|
||||
* [Cookies](cookies)
|
||||
* [Flash messages](flashmessages)
|
||||
* [Body binder](request-body-bind)
|
||||
* [Custom HTTP Errors](custom-http-errors)
|
||||
* [Context](context)
|
||||
* [Logger](logger)
|
||||
* [HTTP access control](middleware-cors)
|
||||
* [Secure](middleware-secure)
|
||||
* [Sessions](package-sessions)
|
||||
* [Websockets](package-websocket)
|
||||
* [Graceful](package-graceful)
|
||||
* [Recovery](middleware-recovery)
|
||||
* [Plugins](plugins)
|
||||
* [Internationalization and Localization](middleware-internationalization-and-localization)
|
||||
* [Easy Typescript](plugin-typescript)
|
||||
* [Browser based Editor](plugin-editor)
|
||||
* [Routes info](plugin-routesinfo)
|
||||
* [Control panel](plugin-iriscontrol)
|
||||
* [Examples](https://github.com/iris-contrib/examples)
|
||||
|
||||
|
||||
|
|
|
|||
88
_Sidebar.md
88
_Sidebar.md
|
|
@ -1,46 +1,46 @@
|
|||
* [Introduction](README.md)
|
||||
* [Features](features.md)
|
||||
* [Versioning](versioning.md)
|
||||
* [Install](install.md)
|
||||
* [Hi](hi.md)
|
||||
* [Transport Layer Security](tls.md)
|
||||
* [Handlers](handlers.md)
|
||||
* [Using Handlers](using-handlers.md)
|
||||
* [Using HandlerFuncs](using-handlerfuncs.md)
|
||||
* [Using Annotated](using-annotated.md)
|
||||
* [Using native http.Handler](using-native-httphandler.md)
|
||||
* [Using native http.Handler via iris.ToHandlerFunc()](using-native-httphandler-via-tohandlerfunc.md)
|
||||
* [Middlewares](middlewares.md)
|
||||
* [API](api.md)
|
||||
* [Declaration](declaration.md)
|
||||
* [Configuration](configuration.md)
|
||||
* [Party](party.md)
|
||||
* [Subdomains](subdomains.md)
|
||||
* [Named Parameters](named-parameters.md)
|
||||
* [Static files](static-files.md)
|
||||
* [Send files](send-files.md)
|
||||
* [Render](render.md)
|
||||
* [REST](render_rest.md)
|
||||
* [Templates](render_templates.md)
|
||||
* [Gzip](gzip.md)
|
||||
* [Streaming](streaming.md)
|
||||
* [Cookies](cookies.md)
|
||||
* [Flash messages](flashmessages.md)
|
||||
* [Body binder](request-body-bind.md)
|
||||
* [Custom HTTP Errors](custom-http-errors.md)
|
||||
* [Context](context.md)
|
||||
* [Logger](logger.md)
|
||||
* [HTTP access control](middleware-cors.md)
|
||||
* [Secure](middleware-secure.md)
|
||||
* [Sessions](package-sessions.md)
|
||||
* [Websockets](package-websocket.md)
|
||||
* [Graceful](package-graceful.md)
|
||||
* [Recovery](middleware-recovery.md)
|
||||
* [Plugins](plugins.md)
|
||||
* [Internationalization and Localization](middleware-internationalization-and-localization.md)
|
||||
* [Easy Typescript](plugin-typescript.md)
|
||||
* [Browser based Editor](plugin-editor.md)
|
||||
* [Routes info](plugin-routesinfo.md)
|
||||
* [Control panel](plugin-iriscontrol.md)
|
||||
* [Introduction](README)
|
||||
* [Features](features)
|
||||
* [Versioning](versioning)
|
||||
* [Install](install)
|
||||
* [Hi](hi)
|
||||
* [Transport Layer Security](tls)
|
||||
* [Handlers](handlers)
|
||||
* [Using Handlers](using-handlers)
|
||||
* [Using HandlerFuncs](using-handlerfuncs)
|
||||
* [Using Annotated](using-annotated)
|
||||
* [Using native http.Handler](using-native-httphandler)
|
||||
* [Using native http.Handler via iris.ToHandlerFunc()](using-native-httphandler-via-tohandlerfunc)
|
||||
* [Middlewares](middlewares)
|
||||
* [API](api)
|
||||
* [Declaration](declaration)
|
||||
* [Configuration](configuration)
|
||||
* [Party](party)
|
||||
* [Subdomains](subdomains)
|
||||
* [Named Parameters](named-parameters)
|
||||
* [Static files](static-files)
|
||||
* [Send files](send-files)
|
||||
* [Render](render)
|
||||
* [REST](render_rest)
|
||||
* [Templates](render_templates)
|
||||
* [Gzip](gzip)
|
||||
* [Streaming](streaming)
|
||||
* [Cookies](cookies)
|
||||
* [Flash messages](flashmessages)
|
||||
* [Body binder](request-body-bind)
|
||||
* [Custom HTTP Errors](custom-http-errors)
|
||||
* [Context](context)
|
||||
* [Logger](logger)
|
||||
* [HTTP access control](middleware-cors)
|
||||
* [Secure](middleware-secure)
|
||||
* [Sessions](package-sessions)
|
||||
* [Websockets](package-websocket)
|
||||
* [Graceful](package-graceful)
|
||||
* [Recovery](middleware-recovery)
|
||||
* [Plugins](plugins)
|
||||
* [Internationalization and Localization](middleware-internationalization-and-localization)
|
||||
* [Easy Typescript](plugin-typescript)
|
||||
* [Browser based Editor](plugin-editor)
|
||||
* [Routes info](plugin-routesinfo)
|
||||
* [Control panel](plugin-iriscontrol)
|
||||
* [Examples](https://github.com/iris-contrib/examples)
|
||||
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ func secondWay() {
|
|||
}
|
||||
```
|
||||
|
||||
Before 3rd way, let's take a quick look at the **[config](configuration.md).Iris**:
|
||||
Before 3rd way, let's take a quick look at the **[config](configuration).Iris**:
|
||||
```go
|
||||
// Iris configs for the station
|
||||
// All fields can be changed before server's listen except the PathCorrection field
|
||||
|
|
@ -135,4 +135,4 @@ for example, if /home/ path is requested but no handler for this Route found,
|
|||
then the Router checks if /home handler exists, if yes, redirects the client to the correct path /home
|
||||
and VICE - VERSA if /home/ is registered but /home is requested then it redirects to /home/ (Default is true)
|
||||
|
||||
- More about configuration [here](configuration.md)
|
||||
- More about configuration [here](configuration)
|
||||
38
features.md
38
features.md
|
|
@ -1,23 +1,23 @@
|
|||
# Features
|
||||
|
||||
* **Switch between template engines**: Select the way you like to parse your html files, switchable via one-line-configuration, [read more](render.md)
|
||||
* **Typescript**: Auto-compile & Watch your client side code via the [typescript plugin](plugin-typescript.md)
|
||||
* **Online IDE**: Edit & Compile your client side code when you are not home via the [editor plugin](plugin-editor.md)
|
||||
* **Iris Online Control**: Web-based interface to control the basics functionalities of your server via the [iriscontrol plugin](plugin-iriscontrol.md). Note that Iris control is still young
|
||||
* **Subdomains**: Easy way to express your api via custom and dynamic subdomains[*](subdomains.md)
|
||||
* **Named Path Parameters**: Probably you already know what that means. If not, [It's easy to learn about](named-parameters.md)
|
||||
* **Custom HTTP Errors**: Define your own html templates or plain messages when http errors occurs[*](custom-http-errors.md)
|
||||
* **Internationalization**: [i18n](middleware-internationalization-and-localization.md)
|
||||
* **Bindings**: Need a fast way to convert data from body or form into an object? Take a look [here](request-body-bind.md)
|
||||
* **Streaming**: You have only one option when streaming comes in game[*](streaming.md)
|
||||
* **Middlewares**: Create and/or use global or per route middlewares with the Iris' simplicity[*](middlewares.md)
|
||||
* **Sessions**: Sessions provides a secure way to authenticate your clients/users [*](package-sessions.md)
|
||||
* **Realtime**: Realtime is fun when you use websockets[*](package-websocket.md)
|
||||
* **Context**: [Context](context.md) is used for storing route params, storing handlers, sharing variables between middlewares, render rich content, send file and much more[*](context.md)
|
||||
* **Plugins**: You can build your own plugins to inject the Iris framework[*](plugins.md)
|
||||
* **Full API**: All http methods are supported[*](api.md)
|
||||
* **Party**: Group routes when sharing the same resources or middlewares. You can organise a party with domains too! [*](party.md)
|
||||
* **Transport Layer Security**: Provide privacy and data integrity between your server and the client[*](tls.md)
|
||||
* **Multi server instances**: Besides the fact that Iris has a default main server. You can declare as many as you need[*](declaration.md)
|
||||
* **Switch between template engines**: Select the way you like to parse your html files, switchable via one-line-configuration, [read more](render)
|
||||
* **Typescript**: Auto-compile & Watch your client side code via the [typescript plugin](plugin-typescript)
|
||||
* **Online IDE**: Edit & Compile your client side code when you are not home via the [editor plugin](plugin-editor)
|
||||
* **Iris Online Control**: Web-based interface to control the basics functionalities of your server via the [iriscontrol plugin](plugin-iriscontrol). Note that Iris control is still young
|
||||
* **Subdomains**: Easy way to express your api via custom and dynamic subdomains[*](subdomains)
|
||||
* **Named Path Parameters**: Probably you already know what that means. If not, [It's easy to learn about](named-parameters)
|
||||
* **Custom HTTP Errors**: Define your own html templates or plain messages when http errors occurs[*](custom-http-errors)
|
||||
* **Internationalization**: [i18n](middleware-internationalization-and-localization)
|
||||
* **Bindings**: Need a fast way to convert data from body or form into an object? Take a look [here](request-body-bind)
|
||||
* **Streaming**: You have only one option when streaming comes in game[*](streaming)
|
||||
* **Middlewares**: Create and/or use global or per route middlewares with the Iris' simplicity[*](middlewares)
|
||||
* **Sessions**: Sessions provides a secure way to authenticate your clients/users [*](package-sessions)
|
||||
* **Realtime**: Realtime is fun when you use websockets[*](package-websocket)
|
||||
* **Context**: [Context](context) is used for storing route params, storing handlers, sharing variables between middlewares, render rich content, send file and much more[*](context)
|
||||
* **Plugins**: You can build your own plugins to inject the Iris framework[*](plugins)
|
||||
* **Full API**: All http methods are supported[*](api)
|
||||
* **Party**: Group routes when sharing the same resources or middlewares. You can organise a party with domains too! [*](party)
|
||||
* **Transport Layer Security**: Provide privacy and data integrity between your server and the client[*](tls)
|
||||
* **Multi server instances**: Besides the fact that Iris has a default main server. You can declare as many as you need[*](declaration)
|
||||
* **Zero configuration**: No need to configure anything, unless you're forced to. Default configurations everywhere, which you can change with ease, well structured
|
||||
* **Zero allocations**: Iris generates zero garbage
|
||||
2
gzip.md
2
gzip.md
|
|
@ -3,7 +3,7 @@
|
|||
Gzip compression is easy.
|
||||
|
||||
|
||||
For **auto-gzip** to all rest and template responses, look the Gzip option at the iris.Config().Render.Rest.Gzip and iris.Config().Render.Template.Gzip [here](render.md)
|
||||
For **auto-gzip** to all rest and template responses, look the Gzip option at the iris.Config().Render.Rest.Gzip and iris.Config().Render.Template.Gzip [here](render)
|
||||
|
||||
```go
|
||||
// WriteGzip writes response with gzipped body to w.
|
||||
|
|
|
|||
4
hi.md
4
hi.md
|
|
@ -94,5 +94,5 @@ func hi(ctx *iris.Context){
|
|||
|
||||
```
|
||||
|
||||
- More about configuration [here](configuration.md)
|
||||
- More about render and template engines [here](render.md)
|
||||
- More about configuration [here](configuration)
|
||||
- More about render and template engines [here](render)
|
||||
|
|
@ -54,7 +54,7 @@ func main(){
|
|||
}
|
||||
```
|
||||
|
||||
Enable [web browser editor](plugin-editor.md)
|
||||
Enable [web browser editor](plugin-editor)
|
||||
|
||||
```go
|
||||
ts := config.Typescript {
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
# Render
|
||||
Click to the headers to open the related doc.
|
||||
|
||||
### [REST](render_rest.md)
|
||||
### [REST](render_rest)
|
||||
Easy and fast way to render any type of data. **JSON, JSONP, XML, Text, Data** .
|
||||
|
||||
### [Templates](render_templates.md)
|
||||
### [Templates](render_templates)
|
||||
|
||||
Iris gives you the freedom to render templates through [html/template](https://golang.org/pkg/html/template) or Django-syntax package [flosch/pongo2](https://github.com/flosch/pongo2)
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
# Subdomains
|
||||
|
||||
Subdomains in Iris are simple [Parties](party.md).
|
||||
Subdomains in Iris are simple [Parties](party).
|
||||
|
||||
```go
|
||||
package main
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user