fortify-schema/docs/web/README.md

A modern TypeScript validation library designed around familiar interface syntax and powerful conditional validation. Experience schema validation that feels natural to TypeScript developers while unlocking advanced runtime validation capabilities.

# Fortify Schema Documentation Website

Official documentation website for Fortify Schema - TypeScript Schema Validation with Interface-Like Syntax.

## 🚀 Quick Start

This is a static website built with HTML, TailwindCSS, and Highlight.js. No build process required!

### Local Development

Simply open `index.html` in your browser or use a local server:

```bash
# Using Python
python -m http.server 8000

# Using Node.js
npx serve

# Using PHP
php -S localhost:8000
```

Then visit `http://localhost:8000`

## 📁 Structure

```
docs/web/
├── index.html           # Homepage
├── bug-fixes.html       # Recent bug fixes documentation
├── make-utility.html    # Make utility API reference
├── mod-utility.html     # Mod utility API reference
├── examples.html        # Usage examples
├── api-reference.html   # Complete API documentation
├── styles.css           # Custom styles
└── README.md           # This file
```

## 🎨 Features

- **Responsive Design**: Works on all devices
- **Syntax Highlighting**: Code examples with Highlight.js
- **TailwindCSS**: Modern utility-first CSS
- **No Build Step**: Pure HTML/CSS/JS
- **Fast Loading**: CDN-based dependencies

## 📝 Content

### Pages

1. **Home** (`index.html`)
   - Quick start guide
   - Key features overview
   - Navigation to all sections

2. **Bug Fixes** (`bug-fixes.html`)
   - Recent array-of-objects validation fixes
   - Type inference improvements
   - Test results and migration guide

3. **Make Utility** (`make-utility.html`)
   - `Make.const()` - Constants
   - `Make.union()` - Union types
   - `Make.unionOptional()` - Optional unions

4. **Mod Utility** (`mod-utility.html`)
   - Schema transformation methods
   - Merge, pick, omit operations
   - Deep partial and defaults

5. **Examples** (`examples.html`)
   - Real-world usage patterns
   - Best practices
   - Common scenarios

6. **API Reference** (`api-reference.html`)
   - Complete API documentation
   - Type definitions
   - Method signatures

## 🔧 Customization

### Colors

The site uses a purple gradient theme. To customize:

1. Edit `styles.css` for the gradient:
```css
.gradient-bg {
    background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
}
```

2. Update TailwindCSS classes in HTML files

### Content

All content is in HTML files. Edit directly:
- Headers: `<header>` sections
- Navigation: `<nav>` sections
- Content: `<main>` sections
- Footer: `<footer>` sections

## 📦 Dependencies

All dependencies are loaded via CDN:

- **TailwindCSS**: `https://cdn.tailwindcss.com`
- **Highlight.js**: `https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/`
- **Google Fonts**: Inter & Fira Code

## 🚢 Deployment

### GitHub Pages

```bash
# Initialize git (if not already)
git init
git add .
git commit -m "Initial documentation"

# Push to GitHub
git remote add origin https://github.com/Nehonix-Team/fortify-docs.git
git branch -M main
git push -u origin main

# Enable GitHub Pages in repository settings
# Source: main branch / root or docs folder
```

### Netlify

1. Drag and drop the `docs/web` folder to Netlify
2. Or connect your GitHub repository
3. Build settings: None needed (static site)

### Vercel

```bash
vercel --prod
```

## 📄 License

MIT License - See main repository for details

## 🤝 Contributing

Contributions welcome! Please submit PRs to the main Fortify Schema repository.

## 🔗 Links

- **Main Repository**: https://github.com/Nehonix-Team/fortify-schema
- **NPM Package**: https://www.npmjs.com/package/fortify-schema
- **Documentation**: https://nehonix-team.github.io/fortify-docs

---

Made with ❤️ by Nehonix Team