Skip to content
Draft
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
44 changes: 44 additions & 0 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Deploy website to GitHub Pages

on:
push:
branches:
- master
- main
workflow_dispatch: {}

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Pages
id: pages
uses: actions/configure-pages@v5

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./website

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,6 @@ coverage/

# Benchmarks
criterion/

# JS tooling
node_modules/
Binary file added website-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
283 changes: 283 additions & 0 deletions website/assets/styles.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,283 @@
@import url('https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap');

:root {
--bg: #0b1221;
--card: #111a2f;
--accent: #4f46e5;
--accent-2: #22d3ee;
--text: #e5e7eb;
--muted: #9ca3af;
--border: #1f2937;
--success: #10b981;
--warning: #fbbf24;
--shadow: 0 20px 60px rgba(0, 0, 0, 0.35);
}

* {
box-sizing: border-box;
}

body {
margin: 0;
font-family: 'Inter', system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', sans-serif;
background: radial-gradient(circle at 10% 20%, rgba(79, 70, 229, 0.08), transparent 25%),
radial-gradient(circle at 90% 10%, rgba(34, 211, 238, 0.08), transparent 25%),
var(--bg);
color: var(--text);
line-height: 1.6;
}

a {
color: var(--accent-2);
text-decoration: none;
}

a:hover {
color: #67e8f9;
}

header {
position: sticky;
top: 0;
z-index: 10;
backdrop-filter: blur(12px);
background: rgba(11, 18, 33, 0.7);
border-bottom: 1px solid var(--border);
}

.nav {
max-width: 1100px;
margin: 0 auto;
padding: 16px 24px;
display: flex;
align-items: center;
justify-content: space-between;
}

.brand {
display: flex;
align-items: center;
gap: 10px;
font-weight: 700;
letter-spacing: -0.02em;
color: var(--text);
}

.nav-links {
display: flex;
gap: 18px;
font-weight: 500;
}

.btn {
display: inline-flex;
align-items: center;
gap: 8px;
padding: 12px 18px;
border-radius: 999px;
border: 1px solid transparent;
background: var(--accent);
color: white;
font-weight: 600;
box-shadow: var(--shadow);
transition: transform 150ms ease, box-shadow 150ms ease, background 150ms ease;
}

.btn.secondary {
background: transparent;
border-color: var(--border);
color: var(--text);
box-shadow: none;
}

.btn:hover {
transform: translateY(-1px);
box-shadow: 0 14px 40px rgba(79, 70, 229, 0.25);
}

.hero {
max-width: 1100px;
margin: 0 auto;
padding: 80px 24px 60px;
display: grid;
grid-template-columns: 1.1fr 0.9fr;
gap: 28px;
align-items: center;
}

.pill {
display: inline-flex;
align-items: center;
gap: 10px;
padding: 8px 14px;
border-radius: 999px;
background: rgba(34, 211, 238, 0.12);
color: #a5f3fc;
font-weight: 600;
border: 1px solid rgba(34, 211, 238, 0.35);
}

h1 {
margin: 18px 0 12px;
font-size: clamp(34px, 4vw, 48px);
letter-spacing: -0.03em;
}

.subtitle {
color: var(--muted);
font-size: 18px;
margin-bottom: 24px;
}

.cta-row {
display: flex;
gap: 12px;
flex-wrap: wrap;
}

.hero-card {
background: linear-gradient(135deg, rgba(79, 70, 229, 0.18), rgba(34, 211, 238, 0.18));
border: 1px solid rgba(255, 255, 255, 0.08);
border-radius: 16px;
padding: 20px;
box-shadow: var(--shadow);
}

.metrics {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(160px, 1fr));
gap: 12px;
margin-top: 16px;
}

.metric {
background: rgba(17, 26, 47, 0.9);
border: 1px solid var(--border);
padding: 14px;
border-radius: 12px;
}

.metric .value {
font-size: 24px;
font-weight: 700;
}

.section {
max-width: 1100px;
margin: 0 auto;
padding: 40px 24px 20px;
}

.section h2 {
margin: 0 0 12px;
font-size: 28px;
}

.cards {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(240px, 1fr));
gap: 16px;
}

.card {
background: var(--card);
border: 1px solid var(--border);
border-radius: 16px;
padding: 18px;
box-shadow: var(--shadow);
}

.card h3 {
margin-top: 0;
margin-bottom: 8px;
}

.code {
background: #0a0f1c;
border: 1px solid var(--border);
border-radius: 12px;
padding: 12px;
font-family: 'Fira Code', 'SFMono-Regular', Menlo, Monaco, Consolas, monospace;
color: #cbd5e1;
position: relative;
}

.code button {
position: absolute;
top: 10px;
right: 10px;
background: rgba(255, 255, 255, 0.08);
border: 1px solid var(--border);
color: var(--text);
padding: 6px 10px;
border-radius: 8px;
cursor: pointer;
font-size: 12px;
}

.grid-2 {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(280px, 1fr));
gap: 18px;
}

.table {
width: 100%;
border-collapse: collapse;
margin-top: 12px;
}

.table th,
.table td {
border: 1px solid var(--border);
padding: 12px;
text-align: left;
}

.table th {
background: rgba(255, 255, 255, 0.04);
}

.badge {
display: inline-block;
padding: 6px 10px;
border-radius: 999px;
font-size: 12px;
background: rgba(79, 70, 229, 0.15);
border: 1px solid rgba(79, 70, 229, 0.4);
color: #c7d2fe;
font-weight: 600;
}

.footer {
max-width: 1100px;
margin: 20px auto;
padding: 16px 24px 40px;
color: var(--muted);
border-top: 1px solid var(--border);
}

.banner {
background: linear-gradient(135deg, rgba(79, 70, 229, 0.25), rgba(34, 211, 238, 0.25));
border: 1px solid rgba(255, 255, 255, 0.08);
border-radius: 16px;
padding: 18px;
box-shadow: var(--shadow);
}

@media (max-width: 900px) {
.hero {
grid-template-columns: 1fr;
padding-top: 60px;
}

.nav {
flex-direction: column;
gap: 10px;
}

.nav-links {
flex-wrap: wrap;
justify-content: center;
}
}
12 changes: 12 additions & 0 deletions website/docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# oops Documentation Hub

Welcome to the extended documentation for **oops**, the blazingly fast command-line typo corrector. Use the links below to dive into detailed guides.

- [Installation](../docs/guides/installation.md)
- [Configuration](../docs/guides/configuration.md)
- [Creating Rules](../docs/guides/creating-rules.md)
- [Migration from thefuck](../docs/guides/migration-from-thefuck.md)
- [Rule Catalog](../docs/guides/rules.md)
- [Architecture Overview](../docs/architecture/overview.md)
- [Shell Integration](../docs/architecture/shell-integration.md)
- [Release Workflow](../docs/releases/QUICK_RELEASE_GUIDE.md)
Loading