Skip to content

Commit bfae588

Browse files
ldezldez
committed
docs: new website
1 parent 80fb42f commit bfae588

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+6191
-3
lines changed

‎CHANGELOG.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@ Follow the news and releases on [Mastodon](https://fosstodon.org/@golangcilint)
22

33
`golangci-lint` is a free and open-source project built by volunteers.
44

5-
If you value it, consider supporting us, we appreciate it! ❤️
5+
If you value it, consider supporting us, we appreciate it!
66

7-
[![Open Collective backers and sponsors](https://img.shields.io/badge/OpenCollective-Donate-blue?logo=opencollective&style=for-the-badge)](https://opencollective.com/golangci-lint)
8-
[![GitHub Sponsors](https://img.shields.io/badge/GitHub-Donate-blue?logo=github&style=for-the-badge)](https://github.com/sponsors/golangci)
7+
[![Donate](https://img.shields.io/badge/Donate-❤️-blue?style=for-the-badge)](https://donate.golangci.org)
98

109
### v2.3.0
1110

‎docs/.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.hugo_build.lock
2+
public/
3+
/static/jsonschema/

‎docs/archetypes/default.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
date: '{{ .Date }}'
3+
draft: true
4+
title: '{{ replace .File.ContentBaseName "-" " " | title }}'
5+
---

‎docs/assets/css/custom.css

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
:root {
2+
--primary-hue: 187deg;
3+
--primary-saturation: 54.4%;
4+
--primary-lightness: 57.8%;
5+
}
6+
7+
/* Allow card subtitle with more than 3 lines */
8+
.hx-line-clamp-3.hextra-card-subtitle {
9+
-webkit-line-clamp: 30;
10+
}

‎docs/content/_index.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: 'Golangci-lint'
3+
layout: hextra-home
4+
params:
5+
width: wide
6+
---
7+
8+
{{< hextra/hero-container image="images/golangci-lint-logo-anim.gif" imageWidth="300" imageHeight="300" imageTitle="golangci-lint" >}}
9+
10+
<div class="hx-mt-6 hx-mb-6">
11+
{{< hextra/hero-headline >}}
12+
Golangci-lint is a fast linters runner for Go.
13+
{{< /hextra/hero-headline >}}
14+
</div>
15+
16+
<div class="hx-mb-12">
17+
{{< hextra/hero-subtitle >}}
18+
It runs linters in parallel, uses caching, supports YAML configuration,&nbsp;<br class="sm:hx-block hx-hidden" />integrates with all major IDEs, and includes over a hundred linters.
19+
{{< /hextra/hero-subtitle >}}
20+
</div>
21+
22+
<div class="hx-mb-6">
23+
{{< hextra/hero-button text="Get Started" link="docs" >}}
24+
</div>
25+
26+
{{< /hextra/hero-container >}}
27+
28+
<div class="hx-mt-6"></div>
29+
30+
{{< hextra/feature-grid cols=3 >}}
31+
{{< hextra/feature-card
32+
icon="fast-forward"
33+
title="Fast"
34+
subtitle="Runs linters in parallel, reuses Go build cache and caches analysis results."
35+
style="background: radial-gradient(ellipse at 50% 80%,rgba(194,97,254,0.15),hsla(0,0%,100%,0));"
36+
link="/docs/" >}}
37+
{{< hextra/feature-card
38+
icon="desktop-computer"
39+
title="Integrations"
40+
subtitle="Integrations with VS Code, Sublime Text, GoLand, GNU Emacs, Vim, GitHub Actions."
41+
style="background: radial-gradient(ellipse at 50% 80%,rgba(142,53,74,0.15),hsla(0,0%,100%,0));"
42+
link="/docs/welcome/integrations" >}}
43+
{{< hextra/feature-card
44+
icon="sparkles"
45+
title="Nice outputs"
46+
subtitle="Text with colors and source code lines, JSON, tab, HTML, Checkstyle, Code-Climate, JUnit-XML, TeamCity, SARIF."
47+
style="background: radial-gradient(ellipse at 50% 80%,rgba(221,210,59,0.15),hsla(0,0%,100%,0));"
48+
link="/docs/usage/configuration/file/#output-configuration" >}}
49+
{{< hextra/feature-card
50+
icon="eye-off"
51+
title="Minimum number of false positives"
52+
subtitle="Tuned default settings."
53+
link="/docs/usage/linters/false-positives" >}}
54+
{{< hextra/feature-card
55+
icon="collection"
56+
title="A lot of linters"
57+
subtitle="No need to install them."
58+
link="/docs/usage/linters" >}}
59+
{{< hextra/feature-card
60+
icon="document-text"
61+
title="YAML-based configuration"
62+
subtitle="Easy to read and maintain."
63+
link="/docs/usage/configuration/file" >}}
64+
{{< /hextra/feature-grid >}}

‎docs/content/docs/_index.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
title: 'Golangci-lint Documentation'
3+
---
4+
5+
{{< hextra/hero-subtitle >}}
6+
Everything you need to know for your golangci-lint journey.
7+
{{< /hextra/hero-subtitle >}}
8+
9+
![golangci-lint demo](/images/demo.gif)
10+
11+
{{< cards >}}
12+
{{< card
13+
link="/docs/welcome/quick-start"
14+
title="Getting Started"
15+
subtitle="Get ready to use golangci-lint"
16+
icon="arrow-circle-right" >}}
17+
{{< card
18+
link="/docs/usage/linters"
19+
title="Linters"
20+
subtitle="List of all the linters"
21+
icon="arrow-circle-right" >}}
22+
{{< card
23+
link="/docs/usage/formatters"
24+
title="Formatters"
25+
subtitle="List of all the formatters"
26+
icon="arrow-circle-right" >}}
27+
{{< /cards >}}
28+
29+
30+
## Supporting Us
31+
32+
Golangci-lint is a free and open-source project built by volunteers.
33+
34+
If you value it, consider supporting us, we appreciate it!
35+
36+
<div class="hx-mb-6"></div>
37+
<div class="hx-mb-6">
38+
{{< hextra/hero-button text="Donate ❤️" link="https://donate.golangci.org" >}}
39+
</div>
40+
41+
## Contributors
42+
43+
This project exists thanks to all the people who contribute. [How to contribute](/docs/contributing/workflow/).
44+
45+
[![golangci-lint contributors](https://opencollective.com/golangci-lint/contributors.svg?width=890&button=false&skip=golangcidev,CLAassistant,renovate,fossabot,golangcibot,kortschak,golangci-releaser,dependabot%5Bbot%5D)](https://github.com/golangci/golangci-lint/graphs/contributors)
46+
47+
## Stargazers over time
48+
49+
<a href="https://starchart.cc/golangci/golangci-lint">
50+
<img
51+
title="Stargazers over time"
52+
src="https://starchart.cc/golangci/golangci-lint.svg"
53+
class="hx-block dark:hx-hidden"
54+
/>
55+
<img
56+
title="Stargazers over time"
57+
src="https://starchart.cc/golangci/golangci-lint.svg?variant=dark"
58+
class="hx-hidden dark:hx-block"
59+
/>
60+
</a>

‎docs/content/docs/contributing/_index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Contributing
3+
weight: 4
4+
---
5+
6+
{{< cards >}}
7+
{{< card link="/docs/contributing/workflow/" title="Contributing workflow" icon="document-text" >}}
8+
{{< card link="/docs/contributing/architecture/" title="Architecture of golangci-lint" icon="code" >}}
9+
{{< card link="/docs/contributing/new-linters/" title="How to add new linters" icon="document-text" >}}
10+
{{< card link="/docs/contributing/debug/" title="Debugging golangci-lint" icon="code" >}}
11+
{{< card link="/docs/contributing/faq/" title="FAQ" icon="question-mark-circle" >}}
12+
{{< card link="/docs/contributing/website/" title="Contributing to this website" icon="globe" >}}
13+
{{< /cards >}}

0 commit comments

Comments
 (0)