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

website with updated modules #280

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .cspell.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# cSpell:ignore textlintrc
# For settings, see
# https://www.streetsidesoftware.com/vscode-spell-checker/docs/configuration/
version: '0.2'
caseSensitive: true
words:
- Docsy
- Gin Web Framework
20 changes: 12 additions & 8 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
version: 2
updates:
- package-ecosystem: github-actions
directory: /
schedule:
interval: weekly
- package-ecosystem: gomod
directory: /
schedule:
interval: weekly
- package-ecosystem: npm
directory: "/"
schedule:
interval: daily
time: '20:00'
open-pull-requests-limit: 10
- package-ecosystem: bundler
directory: "/"
schedule:
interval: daily
time: '20:00'
open-pull-requests-limit: 10
46 changes: 0 additions & 46 deletions .github/workflows/node.yml

This file was deleted.

22 changes: 5 additions & 17 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,17 +1,5 @@
# Binaries for programs and plugins
*.exe
*.exe~
*.dll
*.so
*.dylib

# Test binary, build with `go test -c`
*.test

# Output of the go coverage tool, specifically when used with LiteIDE
*.out

public
resources
node_modules
.hugo_build.lock
/public
resources/
node_modules/
package-lock.json
.hugo_build.lock
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
lts/*
23 changes: 11 additions & 12 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,19 @@ MIT License

Copyright (c) 2018 Gin-Gonic

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
33 changes: 23 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,24 @@

# Gin website

[![Run Deploy](https://github.com/gin-gonic/website/actions/workflows/node.yml/badge.svg)](https://github.com/gin-gonic/website/actions/workflows/node.yml)

Welcome! This repository houses all the assets required to build the Gin website and documentation. We're pleased that you want to contribute! The website is hosted at https://gin-gonic.com.
Welcome! This repository houses all the assets required to build the Gin website
and documentation. We're pleased that you want to contribute! The website is
hosted at https://gin-gonic.com.

We use [Hugo](https://gohugo.io/) to format and generate our website, the [Docsy](https://github.com/google/docsy) theme for styling and site structure. Thanks!.
We use [Hugo](https://gohugo.io/) to format and generate our website, the
[Docsy](https://github.com/google/docsy) theme for styling and site structure.
Thanks!.

**Note:** We only support hugo [v0.75.1 version](https://github.com/gohugoio/hugo/releases/tag/v0.75.1).
**Note:** We only support hugo
[v0.75.1 version](https://github.com/gohugoio/hugo/releases/tag/v0.75.1).

## Contribution

- Fork the repository

You can click the Fork button in the upper-right area of the screen to create a copy of this repository in your GitHub account. This copy is called as fork.
You can click the Fork button in the upper-right area of the screen to create a
copy of this repository in your GitHub account. This copy is called as fork.

> You need to use the below command to clone code for docsy theme.

Expand All @@ -23,15 +28,20 @@ git clone --recurse-submodules --depth 1 https://github.com/google/docsy.git the

- Create one pull request

Make any changes you want in your fork, and when you are ready to send those changes to us, go to your fork and create a new pull request to let us know about it.
Make any changes you want in your fork, and when you are ready to send those
changes to us, go to your fork and create a new pull request to let us know
about it.

- Merge the pull request

Once your pull request is created, a Gin reviewer will take responsibility for providing clear, actionable feedback, re-improve and merge.
Once your pull request is created, a Gin reviewer will take responsibility for
providing clear, actionable feedback, re-improve and merge.

## Running

See the [official Hugo documentation](https://gohugo.io/getting-started/installing/) for Hugo installation instructions.
See the
[official Hugo documentation](https://gohugo.io/getting-started/installing/) for
Hugo installation instructions.

To run the site locally when you have Hugo installed:

Expand All @@ -43,8 +53,11 @@ $ hugo
$ hugo server
```

This will start the local Hugo server on port 1313. Open up your browser to http://localhost:1313 to view the site. As you make changes to the source files, Hugo updates the site and forces a browser refresh.
This will start the local Hugo server on port 1313. Open up your browser to
http://localhost:1313 to view the site. As you make changes to the source files,
Hugo updates the site and forces a browser refresh.

## Thanks

Gin thrives on community participation, and we really appreciate your contributions to our site and our documentation!
Gin thrives on community participation, and we really appreciate your
contributions to our site and our documentation!
3 changes: 0 additions & 3 deletions assets/scss/_variables_project.scss
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,3 @@ Add styles or override variables from the theme here.

*/

$primary: #3176d9 !default;
$dark: #3176d9 !default;

77 changes: 0 additions & 77 deletions content/en/_index.html

This file was deleted.

91 changes: 91 additions & 0 deletions content/en/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
---
title: Gin Web Framework
linkTitle: Gin Web Framework
---

{{< blocks/cover title="Gin Web Framework" image_anchor="top" height="full" >}}
<a class="btn btn-lg btn-primary me-3 mb-4" href="/docs/"> Learn More
<i class="fas fa-arrow-alt-circle-right ms-2"></i> </a>
<a class="btn btn-lg btn-secondary text-dark me-3 mb-4" href="https://github.com/gin-gonic/gin/releases">
Download <i class="fab fa-github ms-2 "></i> </a>

<p class="lead mt-5">The fastest full-featured web framework for Go. Crystal clear.</p>

{{< blocks/link-down color="info" >}} {{< /blocks/cover >}}

{{% blocks/lead color="white" %}}

**What is Gin?**

Gin is a web framework written in Golang. It features a Martini-like API, but
with performance up to 40 times faster than Martini. If you need performance and
productivity, you will love Gin.

{{% /blocks/lead %}}

{{% blocks/section color="light" type="row" %}}
{{% blocks/feature icon="fa-tachometer-alt" title="Fast" %}}

Radix tree based routing, small memory foot print. No reflection. Predictable
API performance.

{{% /blocks/feature %}}

{{% blocks/feature icon="fa-bars" title="Middleware support"%}}

An incoming HTTP request can be handled by a chain of middleware and the final
action. For example: Logger, Authorization, GZIP and finally post a message in
the DB.

{{% /blocks/feature %}}

{{% blocks/feature icon="fa-life-ring" title="Crash-free" %}}

Gin can catch a panic occurred during a HTTP request and recover it. This way,
your server will be always available. It’s also possible to report this panic to
Sentry for example! {{% /blocks/feature %}}

{{% /blocks/section %}}

{{% blocks/section color="white" type="row" %}}

{{% blocks/feature icon="fa-check-circle" title="JSON validation" %}}

Gin can parse and validate the JSON of a request, checking, for example, the
existence of required values.

{{% /blocks/feature %}}

{{% blocks/feature icon="fa-users-cog" title="Routes grouping"%}}

Organize your routes better. Authorization required vs non required, different
API versions. In addition, groups can be nested infinitely without degrading
performance.

{{% /blocks/feature %}}

{{% blocks/feature icon="fa-briefcase" title="Error management" %}}

Gin provides a convenient way to collect all the errors occurred during a HTTP
request. Eventually, middleware can write them to a log file, to a database and
send them through the network.

{{% /blocks/feature %}}

{{% /blocks/section %}}

{{% blocks/section color="info" type="row" %}}

{{% blocks/feature icon="fa-images" title="Rendering built-in" %}}

Gin provides an easy to use API for JSON, XML and HTML rendering.

{{% /blocks/feature %}}

{{% blocks/feature icon="fa-code" title="Extendable"%}}

Creating new middleware is so easy, just check out the sample code.

{{% /blocks/feature %}}

{{% /blocks/section %}}
10 changes: 3 additions & 7 deletions content/en/blog/_index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
---
title: "Blog"
linkTitle: "Blog"
menu:
main:
weight: 30
title: Blog
menu: { main: { weight: 30 } }
linkTitle: Blog
---


This is the **blog** section. It has two categories: News and Releases.

Files in these directories will be listed in reverse chronological order.

Loading