https://github.com/go-macaron/docs
An open source project for Macaron documentation.
https://github.com/go-macaron/docs
documentation go macaron
Last synced: 9 months ago
JSON representation
An open source project for Macaron documentation.
- Host: GitHub
- URL: https://github.com/go-macaron/docs
- Owner: go-macaron
- License: apache-2.0
- Created: 2014-10-16T04:12:12.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2019-11-02T21:26:00.000Z (about 6 years ago)
- Last Synced: 2025-03-27T03:01:45.474Z (10 months ago)
- Topics: documentation, go, macaron
- Homepage: https://go-macaron.com
- Size: 409 KB
- Stars: 14
- Watchers: 2
- Forks: 32
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Macaron
Package macaron is a high productive and modular web framework in Go. It takes basic ideology of [Martini](https://github.com/go-martini/martini) and extends in advance.
{% hint style="info" %}
The minimum requirement of Go is **1.6**.
{% endhint %}
## Quick Start
To install Macaron:
go get gopkg.in/macaron.v1
The very basic usage of Macaron:
```go
package main
import "gopkg.in/macaron.v1"
func main() {
m := macaron.Classic()
m.Get("/", func() string {
return "Hello world!"
})
m.Run()
}
```
## Features
- Powerful routing with suburl.
- Flexible routes combinations.
- Unlimited nested group routers.
- Directly integrate with existing services.
- Dynamically change template files at runtime.
- Allow to use in-memory template and static files.
- Easy to plugin/unplugin features with modular design.
- Handy dependency injection powered by [inject](https://github.com/codegangsta/inject).
- Better router layer and less reflection make faster speed.
## Use Cases
- [Gogs](https://gogs.io): A painless self-hosted Git Service
- [Grafana](http://grafana.org/): The open source analytics & monitoring solution for every database
- [Peach Docs](https://peachdocs.org): A modern documentation web server
- [Go Walker](https://gowalker.org): Go online API documentation
- [Intel Stack](https://intelstack.com/): A 100% free intelligence marketplace
## Getting More
- New to Macaron? Check out the [Starter Guide](starter_guide.md)!
- [Middlewares](middlewares/README.md) that are built for Macaron.
- Have any questions? Maybe there are [answers](faqs.md) for you!
- If you think anything is not clear in the documentation, just [file an issue](https://github.com/go-macaron/docs/issues)!