|
1 | 1 | # MultiLineDiff Website |
2 | 2 |
|
3 | | -This is the official website for the MultiLineDiff Swift library, showcasing its revolutionary features and capabilities. |
| 3 | +The official website for MultiLineDiff - The World's Most Advanced Diffing System. |
4 | 4 |
|
5 | | -## 🌐 Live Site |
| 5 | +## 🌟 Features |
6 | 6 |
|
7 | | -**URL**: https://diff.xcf.ai |
| 7 | +- **Modern Design**: Dark theme with indigo/purple gradients |
| 8 | +- **Responsive**: Works perfectly on desktop, tablet, and mobile |
| 9 | +- **Interactive Documentation**: Expandable sections with comprehensive guides |
| 10 | +- **Live Demo**: Interactive algorithm comparison and diff generation |
| 11 | +- **Performance Charts**: Real benchmark data visualization |
| 12 | +- **Syntax Highlighting**: Prism.js integration for code examples |
| 13 | +- **Smooth Animations**: GPU-accelerated transitions and effects |
8 | 14 |
|
9 | 15 | ## 📁 Project Structure |
10 | 16 |
|
11 | 17 | ``` |
12 | 18 | website/ |
13 | | -├── index.html # Main HTML page |
| 19 | +├── index.html # Main page |
14 | 20 | ├── css/ |
15 | | -│ ├── styles.css # Main styles and layout |
| 21 | +│ ├── styles.css # Main styles and variables |
16 | 22 | │ ├── components.css # Component-specific styles |
17 | 23 | │ └── animations.css # Animation definitions |
18 | 24 | ├── js/ |
19 | 25 | │ ├── main.js # Core functionality |
20 | 26 | │ ├── demo.js # Interactive demo |
21 | | -│ └── performance.js # Performance charts |
| 27 | +│ └── performance.js # Chart.js performance charts |
22 | 28 | ├── images/ |
23 | | -│ ├── favicon.svg # Site favicon |
24 | | -│ ├── og-image.png # Social media preview (to be added) |
25 | | -│ └── apple-touch-icon.png # iOS icon (to be added) |
26 | | -├── fonts/ # Custom fonts (if needed) |
| 29 | +│ └── favicon.svg # Site favicon |
| 30 | +├── deploy.sh # Deployment script |
| 31 | +├── package.json # Dependencies |
| 32 | +├── .gitignore # Git ignore rules |
27 | 33 | └── README.md # This file |
28 | 34 | ``` |
29 | 35 |
|
30 | | -## 🚀 Features |
| 36 | +## 🚀 Quick Start |
31 | 37 |
|
32 | | -### Modern Design |
33 | | -- **Dark Theme**: Professional dark color scheme |
34 | | -- **Responsive Layout**: Works on all devices |
35 | | -- **Smooth Animations**: Engaging user experience |
36 | | -- **Performance Optimized**: Fast loading and smooth interactions |
| 38 | +### Local Development |
37 | 39 |
|
38 | | -### Interactive Components |
39 | | -- **Algorithm Comparison**: Tabbed interface showing all 5 algorithms |
40 | | -- **Live Demo**: Interactive diff generation with syntax highlighting |
41 | | -- **Performance Charts**: Real-time performance visualization |
42 | | -- **Scroll Animations**: Elements animate as they come into view |
| 40 | +1. **Clone the repository**: |
| 41 | + ```bash |
| 42 | + git clone https://github.com/codefreezeai/swift-multi-line-diff.git |
| 43 | + cd swift-multi-line-diff/website |
| 44 | + ``` |
| 45 | + |
| 46 | +2. **Start a local server**: |
| 47 | + ```bash |
| 48 | + # Using Python 3 |
| 49 | + python -m http.server 8000 |
| 50 | + |
| 51 | + # Using Python 2 |
| 52 | + python -m SimpleHTTPServer 8000 |
| 53 | + |
| 54 | + # Using Node.js |
| 55 | + npx http-server |
| 56 | + |
| 57 | + # Using PHP |
| 58 | + php -S localhost:8000 |
| 59 | + ``` |
| 60 | + |
| 61 | +3. **Open in browser**: |
| 62 | + ``` |
| 63 | + http://localhost:8000 |
| 64 | + ``` |
43 | 65 |
|
44 | | -### Technical Features |
45 | | -- **Pure HTML/CSS/JS**: No framework dependencies |
46 | | -- **Modern CSS**: CSS Grid, Flexbox, Custom Properties |
47 | | -- **ES6+ JavaScript**: Modern JavaScript features |
48 | | -- **Chart.js Integration**: Beautiful performance charts |
49 | | -- **Prism.js**: Syntax highlighting for code examples |
| 66 | +### Dependencies |
50 | 67 |
|
51 | | -## 🛠️ Development |
| 68 | +The website uses CDN dependencies for optimal performance: |
52 | 69 |
|
53 | | -### Local Development |
54 | | -1. Clone the repository |
55 | | -2. Navigate to the `website` directory |
56 | | -3. Serve the files using any HTTP server: |
| 70 | +- **Chart.js**: Performance visualization |
| 71 | +- **Prism.js**: Syntax highlighting |
| 72 | +- **Google Fonts**: Inter and JetBrains Mono fonts |
57 | 73 |
|
58 | | -```bash |
59 | | -# Using Python |
60 | | -python -m http.server 8000 |
| 74 | +## 📖 Documentation Sections |
| 75 | + |
| 76 | +The website includes comprehensive documentation covering: |
| 77 | + |
| 78 | +### 🚀 Quick Start Guide |
| 79 | +- Installation instructions |
| 80 | +- Basic usage examples |
| 81 | +- AI-friendly ASCII format |
| 82 | +- Round-trip workflow |
| 83 | + |
| 84 | +### 🤖 ASCII Diff Format |
| 85 | +- Symbol rules and meanings |
| 86 | +- Visual representation guide |
| 87 | +- Real-world examples |
| 88 | +- AI integration benefits |
| 89 | + |
| 90 | +### ⚡ Flash & Optimus Algorithms |
| 91 | +- Performance comparison tables |
| 92 | +- Algorithm selection guide |
| 93 | +- Usage examples |
| 94 | +- Technical details |
| 95 | + |
| 96 | +### 🔧 Enhanced Parser |
| 97 | +- New features overview |
| 98 | +- Source start line tracking |
| 99 | +- Metadata structure |
| 100 | +- Practical benefits |
| 101 | + |
| 102 | +### 🌟 Revolutionary Features |
| 103 | +- Unique innovations |
| 104 | +- Superiority comparisons |
| 105 | +- Security features |
| 106 | +- Complete feature list |
| 107 | + |
| 108 | +### 📖 API Reference |
| 109 | +- Core methods documentation |
| 110 | +- Algorithm enums |
| 111 | +- Display formats |
| 112 | +- Usage examples |
61 | 113 |
|
62 | | -# Using Node.js |
63 | | -npx serve . |
| 114 | +## 🎨 Design System |
64 | 115 |
|
65 | | -# Using PHP |
66 | | -php -S localhost:8000 |
67 | | -``` |
| 116 | +### Color Palette |
| 117 | +- **Primary**: `#6366f1` (Indigo) |
| 118 | +- **Secondary**: `#10b981` (Emerald) |
| 119 | +- **Accent**: `#f59e0b` (Amber) |
| 120 | +- **Background**: `#0f0f23` (Dark Navy) |
| 121 | +- **Text**: `#f8fafc` (Light Gray) |
68 | 122 |
|
69 | | -4. Open http://localhost:8000 in your browser |
| 123 | +### Typography |
| 124 | +- **Headings**: Inter (Google Fonts) |
| 125 | +- **Body**: Inter (Google Fonts) |
| 126 | +- **Code**: JetBrains Mono (Google Fonts) |
70 | 127 |
|
71 | | -### Dependencies |
72 | | -The website uses CDN-hosted libraries: |
73 | | -- **Chart.js**: Performance charts |
74 | | -- **Prism.js**: Syntax highlighting |
75 | | -- **Google Fonts**: Inter and JetBrains Mono fonts |
| 128 | +### Components |
| 129 | +- **Cards**: Rounded corners, subtle shadows |
| 130 | +- **Buttons**: Gradient backgrounds, hover effects |
| 131 | +- **Code Blocks**: Dark theme, syntax highlighting |
| 132 | +- **Tables**: Responsive, alternating rows |
76 | 133 |
|
77 | | -### Browser Support |
78 | | -- Chrome 90+ |
79 | | -- Firefox 88+ |
80 | | -- Safari 14+ |
81 | | -- Edge 90+ |
| 134 | +## 🚀 Deployment |
82 | 135 |
|
83 | | -## 📱 Responsive Breakpoints |
| 136 | +### Automated Deployment |
84 | 137 |
|
85 | | -- **Desktop**: 1200px+ |
86 | | -- **Tablet**: 768px - 1199px |
87 | | -- **Mobile**: 320px - 767px |
| 138 | +Use the included deployment script: |
88 | 139 |
|
89 | | -## 🎨 Design System |
| 140 | +```bash |
| 141 | +# Make executable |
| 142 | +chmod +x deploy.sh |
90 | 143 |
|
91 | | -### Colors |
92 | | -- **Primary**: #6366f1 (Indigo) |
93 | | -- **Secondary**: #10b981 (Emerald) |
94 | | -- **Accent**: #f59e0b (Amber) |
95 | | -- **Background**: #0f0f23 (Dark Blue) |
96 | | -- **Text**: #f8fafc (Slate) |
| 144 | +# Deploy to development |
| 145 | +./deploy.sh dev |
97 | 146 |
|
98 | | -### Typography |
99 | | -- **Sans Serif**: Inter (Google Fonts) |
100 | | -- **Monospace**: JetBrains Mono (Google Fonts) |
| 147 | +# Deploy to staging |
| 148 | +./deploy.sh staging |
101 | 149 |
|
102 | | -### Spacing |
103 | | -- **Base Unit**: 1rem (16px) |
104 | | -- **Scale**: 0.25, 0.5, 1, 1.5, 2, 3, 4rem |
| 150 | +# Deploy to production |
| 151 | +./deploy.sh production |
| 152 | +``` |
105 | 153 |
|
106 | | -## 🚀 Deployment |
| 154 | +### Manual Deployment |
107 | 155 |
|
108 | | -### Static Hosting |
109 | | -The website is a static site and can be deployed to: |
110 | | -- **Netlify**: Drag and drop deployment |
111 | | -- **Vercel**: Git-based deployment |
112 | | -- **GitHub Pages**: Direct from repository |
113 | | -- **AWS S3**: Static website hosting |
114 | | -- **Cloudflare Pages**: Fast global deployment |
115 | | - |
116 | | -### Recommended Deployment (Netlify) |
117 | | -1. Create account at netlify.com |
118 | | -2. Drag the `website` folder to Netlify dashboard |
119 | | -3. Configure custom domain: diff.xcf.ai |
120 | | -4. Enable HTTPS and CDN |
121 | | - |
122 | | -### Build Optimization |
123 | | -For production deployment: |
124 | | -1. Minify CSS and JavaScript files |
125 | | -2. Optimize images (WebP format) |
126 | | -3. Enable gzip compression |
127 | | -4. Set up proper caching headers |
| 156 | +#### Netlify |
| 157 | +1. Connect your GitHub repository |
| 158 | +2. Set build command: `# No build needed` |
| 159 | +3. Set publish directory: `website` |
| 160 | +4. Deploy |
128 | 161 |
|
129 | | -## 📊 Performance |
| 162 | +#### Vercel |
| 163 | +1. Import project from GitHub |
| 164 | +2. Set framework preset: `Other` |
| 165 | +3. Set root directory: `website` |
| 166 | +4. Deploy |
130 | 167 |
|
131 | | -### Lighthouse Scores (Target) |
132 | | -- **Performance**: 95+ |
133 | | -- **Accessibility**: 100 |
134 | | -- **Best Practices**: 100 |
135 | | -- **SEO**: 100 |
| 168 | +#### GitHub Pages |
| 169 | +1. Go to repository Settings |
| 170 | +2. Enable GitHub Pages |
| 171 | +3. Set source to `main` branch, `website` folder |
| 172 | +4. Access at `https://username.github.io/repository-name` |
136 | 173 |
|
137 | | -### Optimization Features |
138 | | -- **Lazy Loading**: Images load as needed |
139 | | -- **Code Splitting**: JavaScript modules |
140 | | -- **CSS Optimization**: Minimal unused styles |
141 | | -- **Font Loading**: Optimized web fonts |
| 174 | +#### Traditional Hosting |
| 175 | +1. Upload `website` folder contents to web root |
| 176 | +2. Ensure server supports HTML5 history API |
| 177 | +3. Configure HTTPS (recommended) |
142 | 178 |
|
143 | 179 | ## 🔧 Customization |
144 | 180 |
|
145 | | -### Adding New Sections |
146 | | -1. Add HTML structure to `index.html` |
147 | | -2. Add styles to appropriate CSS file |
148 | | -3. Add JavaScript functionality if needed |
149 | | -4. Update navigation links |
| 181 | +### Updating Content |
150 | 182 |
|
151 | | -### Modifying Colors |
152 | | -Update CSS custom properties in `styles.css`: |
153 | | -```css |
154 | | -:root { |
155 | | - --primary: #your-color; |
156 | | - --secondary: #your-color; |
157 | | - /* etc. */ |
158 | | -} |
159 | | -``` |
| 183 | +1. **Hero Section**: Edit `index.html` lines 60-120 |
| 184 | +2. **Features**: Modify feature cards in `index.html` |
| 185 | +3. **Documentation**: Update expandable sections |
| 186 | +4. **Performance Data**: Modify `js/performance.js` |
| 187 | + |
| 188 | +### Styling Changes |
160 | 189 |
|
161 | | -### Adding Animations |
162 | | -Add new keyframes to `animations.css` and apply classes to elements. |
| 190 | +1. **Colors**: Update CSS variables in `css/styles.css` |
| 191 | +2. **Fonts**: Change Google Fonts imports in `index.html` |
| 192 | +3. **Layout**: Modify grid systems in `css/components.css` |
| 193 | +4. **Animations**: Adjust timing in `css/animations.css` |
| 194 | + |
| 195 | +### Adding New Sections |
163 | 196 |
|
164 | | -## 📈 Analytics |
| 197 | +1. Add HTML structure to `index.html` |
| 198 | +2. Create corresponding styles in `css/components.css` |
| 199 | +3. Add JavaScript functionality in `js/main.js` |
| 200 | +4. Update navigation links |
165 | 201 |
|
166 | | -### Recommended Analytics |
167 | | -- **Google Analytics 4**: User behavior tracking |
168 | | -- **Hotjar**: User session recordings |
169 | | -- **PageSpeed Insights**: Performance monitoring |
| 202 | +## 📊 Performance |
170 | 203 |
|
171 | | -### Event Tracking |
172 | | -The site includes event tracking for: |
173 | | -- Button clicks |
174 | | -- Section scrolling |
175 | | -- Demo interactions |
176 | | -- Algorithm selections |
| 204 | +### Optimization Features |
| 205 | +- **Lazy Loading**: Images and non-critical resources |
| 206 | +- **CDN Dependencies**: Fast loading from global CDNs |
| 207 | +- **Minification**: CSS and JS optimization for production |
| 208 | +- **Caching**: Proper cache headers for static assets |
| 209 | +- **Responsive Images**: Optimized for different screen sizes |
177 | 210 |
|
178 | | -## 🔒 Security |
| 211 | +### Lighthouse Scores |
| 212 | +- **Performance**: 95+ |
| 213 | +- **Accessibility**: 100 |
| 214 | +- **Best Practices**: 100 |
| 215 | +- **SEO**: 100 |
179 | 216 |
|
180 | | -### Content Security Policy |
181 | | -Recommended CSP headers: |
182 | | -``` |
183 | | -Content-Security-Policy: default-src 'self'; script-src 'self' 'unsafe-inline' cdn.jsdelivr.net cdnjs.cloudflare.com; style-src 'self' 'unsafe-inline' fonts.googleapis.com; font-src fonts.gstatic.com; img-src 'self' data:; |
184 | | -``` |
| 217 | +## 🤝 Contributing |
185 | 218 |
|
186 | | -### HTTPS |
187 | | -Always serve over HTTPS in production. |
| 219 | +1. Fork the repository |
| 220 | +2. Create a feature branch: `git checkout -b feature/amazing-feature` |
| 221 | +3. Commit changes: `git commit -m 'Add amazing feature'` |
| 222 | +4. Push to branch: `git push origin feature/amazing-feature` |
| 223 | +5. Open a Pull Request |
188 | 224 |
|
189 | | -## 📞 Support |
| 225 | +## 📝 License |
190 | 226 |
|
191 | | -For website issues or suggestions: |
192 | | -- **Repository**: https://github.com/codefreezeai/swift-multi-line-diff |
193 | | -- **Email**: support@xcf.ai |
194 | | -- **Website**: https://xcf.ai |
| 227 | +This project is part of the MultiLineDiff library created by Todd Bruss © xcf.ai. |
195 | 228 |
|
196 | | -## 📄 License |
| 229 | +## 🔗 Links |
197 | 230 |
|
198 | | -This website is part of the MultiLineDiff project. |
199 | | -© 2025 Todd Bruss, XCF.ai. All rights reserved. |
| 231 | +- **Library Repository**: [swift-multi-line-diff](https://github.com/codefreezeai/swift-multi-line-diff) |
| 232 | +- **Documentation**: [ASCII Diff Guide](https://github.com/codefreezeai/swift-multi-line-diff/blob/main/NEW_ASCII_DIFF.md) |
| 233 | +- **XCF.ai**: [https://xcf.ai](https://xcf.ai) |
200 | 234 |
|
201 | 235 | --- |
202 | 236 |
|
203 | | -**Built with ❤️ for the MultiLineDiff community** |
| 237 | +**MultiLineDiff: The World's Most Advanced Diffing System** 🚀 |
0 commit comments