Modern, responsive documentation website for LOLAPI built with Next.js, React, and Tailwind CSS.

• 🎨 Beautiful Design: Modern UI with gradient accents and smooth animations
• 📱 Responsive: Mobile-first design that works on all devices
• 🎯 Fast: Static site export for lightning-fast performance
• 🔍 SEO Friendly: Optimized for search engines
• ♿ Accessible: WCAG-compliant design
• 🌐 No Dependencies: Pure HTML/CSS/JS export - no runtime required

• Home: Hero section with key information, stats, and features
• API Browser: Interactive API catalog with search and filtering
• Documentation: Guides for detection, mitigation, and data format
• Getting Started: Installation and quick start guide
• Community: Community guidelines and contribution information
• Contributing: Guidelines for submitting new APIs
• Security: Responsible disclosure policy
• License: MIT License information

• Node.js 16+ (18+ recommended)
• npm or yarn

1. Install dependencies:

npm install

2. Start development server:

npm run dev

3. Open http://localhost:3000 in your browser

The site will auto-reload when you make changes.

Build the site for production and export to static HTML:

npm run build

This generates an out/ directory with static files ready for deployment.

The website is configured to deploy to GitHub Pages at:

https://TheMagicClaw.github.io/LOLAPI/

docs-next/
├── app/
│   ├── layout.tsx              # Root layout
│   ├── globals.css             # Global styles
│   ├── page.tsx                # Home page
│   ├── api-browser/page.tsx    # API browser
│   ├── docs/page.tsx           # Documentation
│   ├── getting-started/page.tsx # Getting started
│   ├── community/page.tsx      # Community
│   ├── contributing/page.tsx   # Contributing guidelines
│   ├── security/page.tsx       # Security policy
│   ├── license/page.tsx        # License info
│   ├── not-found.tsx           # 404 page
│   └── components/
│       ├── Header.tsx          # Navigation header
│       └── Footer.tsx          # Footer
├── public/                     # Static assets
├── next.config.js             # Next.js configuration
├── tailwind.config.js         # Tailwind CSS configuration
├── tsconfig.json              # TypeScript configuration
└── package.json               # Dependencies

• Framework: Next.js 14
• UI Framework: React 18
• Styling: Tailwind CSS
• Language: TypeScript
• Build: Node.js + npm

The site automatically deploys to GitHub Pages via GitHub Actions when:

• Code is pushed to the main branch
• Files in docs-next/ are modified
• The workflow file is updated

Deployment workflow: .github/workflows/deploy.yml

Edit tailwind.config.js to customize the color scheme:

theme: {
  extend: {
    colors: {
      primary: '#667eea',
      secondary: '#764ba2',
    },
  },
}

Edit pages in app/ to update content. For example:

• app/page.tsx - Home page
• app/api-browser/page.tsx - API browser
• etc.

Global styles are in app/globals.css. Component-specific styles use Tailwind CSS classes.

• ✅ Static export - no runtime overhead
• ✅ Optimized images
• ✅ Minimal CSS
• ✅ Fast page loads

• Semantic HTML
• ARIA labels where needed
• Keyboard navigation support
• High contrast colors
• Alt text for images

MIT License - See LICENSE file for details

Contributions are welcome! Please see the contributing guidelines at /community.

For issues, questions, or suggestions:

• 📝 Open an issue on GitHub
• 💬 Start a discussion
• 📧 Contact the team

Built with ❤️ for the security community