Skip to content

Commit aa5fc1a

Browse files
committed
feat: redesign hero section with modern gradient and CTA buttons
1 parent bdc6b3b commit aa5fc1a

47 files changed

Lines changed: 3806 additions & 35 deletions

Some content is hidden

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

.github/workflows/deploy.yml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Deploy Zola site to Pages
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: false
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v4
23+
24+
- name: Setup Zola
25+
uses: taiki-e/install-action@v2
26+
with:
27+
tool: zola
28+
29+
- name: Build with Zola
30+
run: zola build
31+
32+
- name: Upload artifact
33+
uses: actions/upload-pages-artifact@v3
34+
with:
35+
path: public
36+
37+
deploy:
38+
environment:
39+
name: github-pages
40+
url: ${{ steps.deployment.outputs.page_url }}
41+
runs-on: ubuntu-latest
42+
needs: build
43+
steps:
44+
- name: Deploy to GitHub Pages
45+
id: deployment
46+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Zola output directory
2+
public/
3+
4+
# OS files
5+
.DS_Store
6+
Thumbs.db
7+
8+
# Editor files
9+
.vscode/
10+
.idea/
11+
*.swp
12+
*.swo
13+
*~
14+
15+
# Backup files
16+
*.backup
17+
.env.backup

README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# envcheck Documentation
2+
3+
This is the official documentation website for [envcheck](https://github.com/envcheck/envcheck), built with [Zola](https://www.getzola.org/) static site generator.
4+
5+
## Local Development
6+
7+
### Install Zola
8+
9+
```bash
10+
# macOS
11+
brew install zola
12+
13+
# Linux
14+
cargo install zola
15+
16+
# Or download from https://www.getzola.org/
17+
```
18+
19+
### Serve Locally
20+
21+
```bash
22+
zola serve
23+
```
24+
25+
Visit http://127.0.0.1:1111/
26+
27+
### Build
28+
29+
```bash
30+
zola build
31+
```
32+
33+
Output is in `public/`.
34+
35+
## Project Structure
36+
37+
```
38+
.
39+
├── config.toml # Zola configuration
40+
├── content/ # Documentation content (Markdown)
41+
│ ├── introduction/ # Getting started
42+
│ ├── commands/ # CLI reference
43+
│ ├── rules/ # Lint rules
44+
│ ├── integration/ # CI/CD integration
45+
│ └── advanced/ # Advanced topics
46+
├── static/ # Static assets
47+
├── themes/ # Zola themes (book)
48+
└── .github/
49+
└── workflows/
50+
└── deploy.yml # GitHub Pages deployment
51+
```
52+
53+
## Deployment
54+
55+
The site is automatically deployed to GitHub Pages on push to `main`.
56+
57+
## Contributing
58+
59+
1. Edit content in `content/`
60+
2. Test locally: `zola serve`
61+
3. Submit a PR
62+
63+
## License
64+
65+
MIT

config.toml

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# envcheck Documentation Site Configuration
2+
3+
base_url = "https://envcheck.github.io"
4+
title = "envcheck"
5+
description = "⚡️ Fast .env linter with DevSecOps superpowers - K8s, Terraform, Ansible, Helm, ArgoCD integration. Written in Rust 🦀"
6+
default_language = "en"
7+
theme = "book"
8+
9+
# Syntax highlighting - inline styles
10+
[markdown]
11+
highlight_code = true
12+
highlight_theme = "inspired-github"
13+
render_emoji = true
14+
15+
# Search functionality
16+
build_search_index = true
17+
18+
[link_checker]
19+
skip_prefixes = [
20+
"http://[2001:db8::]/"
21+
]
22+
23+
[slugify]
24+
paths = "on"
25+
taxonomies = "on"
26+
anchors = "on"
27+
28+
# Book theme configuration
29+
[extra]
30+
# Primary brand color (Rust orange)
31+
book_primary_color = "#f74c00"
32+
book_secondary_color = "#2d3748"
33+
34+
# Navigation
35+
book_number_chapters = false
36+
book_only_current_section_pages = true
37+
38+
# Search
39+
book_search_enabled = true
40+
41+
# Menu items (shown in top nav)
42+
book_menu_title = "envcheck"
43+
44+
# Repository link for "Edit this page" buttons
45+
book_repo_url = "https://github.com/envcheck/envcheck.github.io"
46+
47+
# Footer
48+
book_footer_copyright = "Copyright © 2025 envcheck contributors"
49+
book_footer_license = "MIT License"
50+
book_footer_license_url = "https://github.com/envcheck/envcheck/blob/main/LICENSE"
51+
52+
# Custom CSS
53+
custom_css = ["custom.css", "syntax.css"]
54+
55+
# Social / SEO
56+
og_image = "/cover.png"
57+
twitter_handle = "@envcheck"
58+
github_url = "https://github.com/envcheck/envcheck"
59+
60+
[extra.book]
61+
include_all = true
62+

content/_index.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
+++
2+
title = "envcheck Documentation"
3+
sort_by = "weight"
4+
template = "section.html"
5+
weight = 0
6+
7+
[extra]
8+
hero_title = "envcheck"
9+
hero_subtitle = "Fast .env linter with DevSecOps superpowers. Written in Rust 🦀"
10+
hero_buttons = [
11+
{ text = "Get Started", link = "/installation", class = "btn-primary" },
12+
{ text = "GitHub", link = "https://github.com/envcheck/envcheck", class = "btn-secondary" }
13+
]
14+
+++
15+
16+
## What is envcheck?
17+
18+
**envcheck** is a fast, modern Rust CLI for linting `.env` files and ensuring environment synchronization across your entire DevSecOps stack.
19+
20+
## Why envcheck?
21+
22+
| Feature | envcheck 🦀 | dotenv-linter |
23+
|---------|-------------|---------------|
24+
| **Linting** |||
25+
| **Compare** |||
26+
| **K8s Sync** |||
27+
| **Terraform** |||
28+
| **Ansible** |||
29+
| **Helm** |||
30+
| **ArgoCD** |||
31+
| **GitHub Actions Check** |||
32+
| **TUI Mode** |||
33+
| **SARIF Output** |||
34+
| **Config Files** |||
35+
| **Shell Completions** |||
36+
| **Auto-Fix + Commit/PR** || ✅ (fix only) |
37+
38+
## DevSecOps Integrations
39+
40+
| Integration | Command | What it checks |
41+
|-------------|---------|----------------|
42+
| **Kubernetes** | `envcheck k8s-sync` | SecretKeyRef/ConfigMapKeyRef vs `.env` |
43+
| **Terraform** | `envcheck terraform` | `TF_VAR_*` variable usage |
44+
| **Ansible** | `envcheck ansible` | `lookup('env', 'VAR')` calls |
45+
| **GitHub Actions** | `envcheck actions` | `env:` blocks in workflows |
46+
| **Helm** | `envcheck helm` | `SCREAMING_SNAKE_CASE` in `values.yaml` |
47+
| **ArgoCD** | `envcheck argo` | `plugin.env` and `kustomize.commonEnv` |
48+
49+
## License
50+
51+
MIT License - See [GitHub](https://github.com/envcheck/envcheck) for details.

content/advanced/_index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
+++
2+
title = "⚙️ Configuration"
3+
weight = 5
4+
sort_by = "weight"
5+
template = "section.html"
6+
+++
7+
8+
# Advanced Topics
9+
10+
Advanced configuration and usage of envcheck.

0 commit comments

Comments
 (0)