{"id":29092425,"url":"https://github.com/zyrasoftware/zyros","last_synced_at":"2025-06-28T07:06:59.111Z","repository":{"id":301001727,"uuid":"1003159098","full_name":"zyrasoftware/zyros","owner":"zyrasoftware","description":"A developer-friendly static site generator built with Next.js and Tailwind CSS. Transform a simple JSON file into a beautiful, fast static website with powerful features that developers and content creators love.","archived":false,"fork":false,"pushed_at":"2025-06-24T16:25:37.000Z","size":1328,"stargazers_count":4,"open_issues_count":0,"forks_count":2,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-24T17:38:12.508Z","etag":null,"topics":["nextjs","react","ssg","static-site-generator","tailwindcss","zyros","zyros-ssg"],"latest_commit_sha":null,"homepage":"https://zyros.vercel.app/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zyrasoftware.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-16T18:03:10.000Z","updated_at":"2025-06-24T16:25:41.000Z","dependencies_parsed_at":"2025-06-24T17:40:02.020Z","dependency_job_id":"c8a8c6a3-8747-44b6-8944-c0c0389ccdf2","html_url":"https://github.com/zyrasoftware/zyros","commit_stats":null,"previous_names":["zyrasoftware/zyros"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/zyrasoftware/zyros","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zyrasoftware%2Fzyros","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zyrasoftware%2Fzyros/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zyrasoftware%2Fzyros/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zyrasoftware%2Fzyros/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zyrasoftware","download_url":"https://codeload.github.com/zyrasoftware/zyros/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zyrasoftware%2Fzyros/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262389494,"owners_count":23303343,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nextjs","react","ssg","static-site-generator","tailwindcss","zyros","zyros-ssg"],"created_at":"2025-06-28T07:06:53.398Z","updated_at":"2025-06-28T07:06:59.103Z","avatar_url":"https://github.com/zyrasoftware.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🚀 zyros\n\n⚫ Name changed from Zyros-ssg to Zyros.\n\nA **developer-friendly static site generator** built with Next.js and Tailwind CSS. Transform a simple JSON file into a beautiful, fast static website with powerful features that developers and content creators love.\n\n![zyros](https://img.shields.io/badge/zyros-v2.1.4-blue)\n![Next.js](https://img.shields.io/badge/Next.js-15.3.3-black)\n![Tailwind CSS](https://img.shields.io/badge/Tailwind-4.0-blue)\n![TypeScript](https://img.shields.io/badge/TypeScript-5.0-blue)\n![npm](https://img.shields.io/npm/v/zyros)\n![License](https://img.shields.io/npm/l/zyros)\n![Status](https://img.shields.io/badge/status-production%20ready-brightgreen)\n\n## 🎉 Recent Improvements (v2.1.4)\n\nBased on valuable community feedback, we've made significant improvements:\n\n- ✅ **Fixed dark theme text visibility** - Intelligent color contrast for all themes\n- ✅ **Scalable content management** - Multi-file markdown support with frontmatter\n- ✅ **Enhanced documentation** - Clear analytics dashboard access and security guidelines\n- ✅ **Backward compatibility** - Existing projects continue to work seamlessly\n- 🔄 **CLI optimization** - Deprecated redundant commands (use `npm run dev/build` instead)\n\n\u003e 📋 **Coming in v2.1.5**: Dependency-based architecture for easy updates and maintenance\n\n## DEMO\n**https://zyros.vercel.app/**\n![Demo](demo.png)\n\n## ✨ Features\n\n### 🎯 Core Features\n- 📄 **JSON-based content management** - Define your entire site in a single JSON file\n- 🎨 **13 Beautiful themes** - Choose from light, dark, minimal, ocean, sunset, forest, midnight, neon, aurora, autumn, cyberpunk, and sakura themes\n- 📝 **Enhanced Markdown support** - Write content in Markdown with beautiful rendering and syntax highlighting\n- ⚡ **Static generation** - Lightning-fast sites with Next.js static export\n- 📱 **Responsive design** - Mobile-first, beautiful on all devices with smooth animations\n- 🎯 **Zero configuration** - Works out of the box\n\n### 🤖 AI-Powered Features\n- 🧠 **AI Content Generator** - Generate blog posts, landing pages, and content blocks with AI assistance\n- 📊 **SEO Analyzer** - Real-time SEO analysis with optimization suggestions and scoring\n- ⚡ **Performance Dashboard** - Monitor Core Web Vitals, Lighthouse scores, and user metrics\n- 🎨 **Visual Page Builder** - Drag-and-drop page builder for creating pages without code\n\n### 🔍 Advanced Search \u0026 Discovery\n- 🔍 **Smart search** - Built-in fuzzy search with keyboard shortcuts (⌘+K)\n- 🏷️ **Advanced filtering** - Filter by categories, tags, and publication date\n- 📊 **Search analytics** - Track popular search queries and optimize content\n\n### 🎨 User Experience\n- 🌈 **Dynamic theme switcher** - Real-time theme switching with local storage persistence\n- 📖 **Reading progress** - Visual progress bar and reading time estimation\n- 📑 **Table of contents** - Auto-generated navigation for long articles\n- 📋 **Copy code blocks** - One-click copying with visual feedback\n- ⌨️ **Keyboard navigation** - Full keyboard accessibility support\n- 🎭 **Smooth animations** - Beautiful transitions and micro-interactions\n\n### 📊 Analytics \u0026 Insights\n- 📈 **Built-in analytics** - Track page views, reading time, and user engagement\n- 🔍 **Search analytics** - Monitor what users are searching for\n- 🎨 **Theme preferences** - Understand which themes are most popular\n- 📊 **Performance metrics** - Monitor scroll depth and content engagement\n- 💾 **Privacy-first** - All analytics stored locally, no external tracking\n\n#### Accessing the Analytics Dashboard\n\nYour Zyros site includes a powerful analytics dashboard at `/analytics`:\n\n**Development Mode:**\n```bash\nnpm run dev\n# Visit http://localhost:3000/analytics\n```\n\n**Production Mode:**\n```bash\nnpm run build\nnpm run start\n# Visit http://yoursite.com/analytics\n```\n\n\u003e **🔒 Security Note**: The analytics dashboard is publicly accessible by default. For production sites, consider implementing authentication or restricting access via your hosting provider's settings.\n\n**Features include:**\n- Real-time page performance metrics\n- Search query analytics\n- Theme preference tracking\n- Content engagement insights\n- Data export functionality\n\n### 🚀 Social \u0026 Engagement\n- 📤 **Social sharing** - Share articles on Twitter, Facebook, LinkedIn with native support\n- 📧 **Newsletter subscription** - Built-in email collection with local storage\n- 🔗 **Copy link sharing** - Easy link copying with visual feedback\n- 📱 **Mobile sharing** - Native mobile sharing API support\n\n### 🛠️ Developer Tools\n- 🖥️ **CLI content management** - Create, edit, and manage content from the command line\n- 📊 **Content statistics** - View detailed stats about your content\n- 🔧 **TypeScript support** - Full type safety and better developer experience\n- 📦 **Plugin-ready architecture** - Extensible design for future enhancements\n- 🎨 **Template system** - Multiple starter templates for different use cases\n- 🔍 **Content validation** - Validate your content structure and catch errors\n- 🖼️ **Image optimization** - Automatic image compression and WebP generation\n- 🚀 **One-click deployment** - Deploy to Vercel, Netlify, GitHub Pages, and more\n\n### 📊 SEO \u0026 Performance\n- 📊 **SEO optimized** - Automatic meta tags, Open Graph, and structured data\n- 🚀 **Performance optimized** - Lighthouse scores of 100/100\n- 📱 **Mobile-first** - Responsive design that works on all devices\n- 🔍 **Search engine friendly** - Optimized for discoverability\n- 📡 **RSS feed generation** - Automatic RSS feed for your content\n- 🗺️ **Sitemap generation** - SEO-friendly sitemaps\n\n## 🚀 Quick Start\n\n### ⚡ Recommended: Using npx (No Installation Required)\n\nThe easiest and recommended way to get started:\n\n```bash\n# Create a new project (recommended)\nnpx zyros@latest init my-blog or zyros init after npm install -g zyros\n\n# Navigate to your project\ncd my-blog\n\n# Install dependencies\nnpm install\n\n# Start development server\nnpm run dev\n```\n\nYour site will be available at `http://localhost:3000`!\n\n\u003e **💡 Why npx?** Using `npx zyros@latest init` ensures you always get the latest version without installing zyros globally.\n\n### 🌍 Alternative: Global Installation\n\nIf you prefer to install zyros globally:\n\n```bash\n# Install globally\nnpm install -g zyros\n\n# Create projects anywhere\nzyros init my-blog\ncd my-blog\nnpm install\nnpm run dev\n```\n\n### ⚠️ Important: Don't Install as Project Dependency\n\n**❌ Don't do this:**\n```bash\nnpm install zyros  # This installs zyros as a dependency, not what you want!\n```\n\n**✅ Do this instead:**\n```bash\nnpx zyros@latest init my-project  # Creates a new project\n# OR\nnpm install -g zyros              # Installs CLI globally\n```\n\n\u003e **Note:** zyros is a CLI tool for creating projects, not a library dependency. If you accidentally run `npm install zyros` in a project directory, you can safely delete the created `package.json` and `node_modules`.\n\n### What You Get\n\nWhen you run `npx zyros init`, you get a **complete copy** of the entire zyros project including:\n\n- ✅ **All components** - Advanced search, content blocks, forms, layouts (including Layout.tsx)\n- ✅ **All themes** - 8 beautiful themes ready to use\n- ✅ **Demo content** - Rich example content to learn from\n- ✅ **Full functionality** - Analytics, social sharing, newsletter, etc.\n- ✅ **Development tools** - TypeScript, ESLint, Tailwind CSS configured\n- ✅ **Deployment ready** - Build scripts and deployment configurations\n- ✅ **Production tested** - Thoroughly validated and error-free\n\n### 🛠️ For Contributors \u0026 Advanced Users\n\n```bash\n# Clone for contributing or customization\ngit clone https://github.com/zyrasoftware/zyros.git\ncd zyros\nnpm install\nnpm run dev\n```\n\n## 📁 Project Structure\n\nWhen you run `npx zyros init my-blog`, you get the complete project structure:\n\n```\nmy-blog/\n├── components/            # React components\n│   ├── Layout.tsx        # Main layout component\n│   ├── ContentBlocks.tsx # Advanced content blocks\n│   ├── AdvancedSearch.tsx # Search functionality\n│   └── ...               # All other components\n├── pages/                # Next.js pages\n│   ├── index.tsx         # Homepage\n│   ├── [slug].tsx        # Dynamic pages\n│   └── analytics.tsx     # Analytics dashboard\n├── styles/               # Styling\n│   ├── globals.css       # Global styles\n│   └── themes.ts         # Theme definitions\n├── lib/                  # Utilities\n│   ├── contentLoader.ts  # Content loading logic\n│   └── analytics.ts      # Analytics functions\n├── public/               # Static assets\n│   ├── site.json         # Your content and configuration\n│   ├── favicon.svg       # Site favicon\n│   └── ...               # Other assets\n├── types/                # TypeScript definitions\n├── scripts/              # Build and utility scripts\n├── next.config.ts        # Next.js configuration\n├── tailwind.config.js    # Tailwind CSS configuration\n├── tsconfig.json         # TypeScript configuration\n└── package.json          # Dependencies and scripts\n```\n\n## 🎨 Themes\n\nChoose from thirteen stunning themes, each with unique color palettes and visual styles:\n\n### Available Themes\n- **Light** - Clean and bright with excellent readability\n- **Dark** - Easy on the eyes with modern dark aesthetics  \n- **Minimal** - Simple and elegant stone-inspired design\n- **Ocean** - Cool and refreshing cyan-blue gradients\n- **Sunset** - Warm and vibrant orange-pink tones\n- **Forest** - Natural and calming emerald-green palette\n- **Midnight** - Deep and mysterious purple-slate combination\n- **Neon** - Bold and electric green-on-black cyberpunk style\n- **Aurora** - Mystical northern lights with purple-pink gradients\n- **Autumn** - Warm amber and orange fall-inspired palette\n- **Cyberpunk** - High-contrast cyan and magenta futuristic design\n- **Sakura** - Delicate pink cherry blossom aesthetic\n\n### Usage\n```json\n{\n  \"site\": {\n    \"theme\": \"ocean\"\n  }\n}\n```\n\n### Dynamic Theme Switching\nUsers can switch themes in real-time using the theme switcher in the header. Theme preferences are automatically saved to local storage.\n\n## 📝 Content Format\n\n### Site Configuration\n\n```json\n{\n  \"site\": {\n    \"title\": \"Your Site Title\",\n    \"theme\": \"light\",\n    \"description\": \"Your site description\",\n    \"author\": \"Your Name\",\n    \"url\": \"https://yoursite.com\"\n  },\n  \"pages\": [\n    {\n      \"title\": \"Page Title\",\n      \"slug\": \"url-slug\",\n      \"content\": \"# Your Markdown Content\\n\\nWrite your content here...\",\n      \"description\": \"Page description for SEO\",\n      \"category\": \"blog\",\n      \"tags\": [\"tag1\", \"tag2\"],\n      \"publishedAt\": \"2024-01-15\",\n      \"readingTime\": 5\n    }\n  ]\n}\n```\n\n### Markdown Support\n\nzyros supports full Markdown syntax:\n\n- **Headers** (`# ## ###`)\n- **Bold** and *italic* text\n- [Links](https://example.com)\n- Lists (ordered and unordered)\n- `Code blocks` and syntax highlighting\n- \u003e Blockquotes\n- Tables\n- Images\n- And more!\n\n## 🛠️ CLI Commands\n\n### Content Management\n```bash\n# Create a new post\nzyros content create\n\n# List all posts\nzyros content list\n\n# Delete a post\nzyros content delete\n\n# Show content statistics\nzyros content stats\n```\n\n### Project Management\n```bash\n# Initialize new project\nzyros init my-site\n\n# Build for production\nzyros build\n\n# Start development server\nzyros dev\n\n# Validate content and structure\nzyros validate\n\n# Optimize images and assets\nzyros optimize\n```\n\n### Template Management\n```bash\n# List available templates\nzyros template list\n\n# Apply a template\nzyros template apply minimal\n\n# Create custom template\nzyros template create my-template\n```\n\n### Deployment\n```bash\n# Deploy to Vercel\nzyros deploy vercel\n\n# Deploy to Netlify\nzyros deploy netlify\n\n# Deploy to GitHub Pages\nzyros deploy github\n\n# Deploy to AWS S3\nzyros deploy s3 my-bucket\n```\n\n### Configuration\n```bash\n# Show all configuration\nzyros config --list\n\n# Get specific value\nzyros config --get site.title\n\n# Set configuration value\nzyros config --set site.theme=dark\n```\n\n## 🎨 Templates\n\nzyros comes with multiple templates for different use cases:\n\n- **Default** - Clean blog template\n- **Portfolio** - Showcase your work\n- **Documentation** - Technical docs\n- **Business** - Professional website\n- **Minimal** - Ultra-clean design\n\n```bash\n# Use a specific template\nzyros init my-site --template portfolio\n```\n\n## 🔧 Advanced Configuration\n\n### Custom Themes\n\nCreate your own theme by extending the theme system:\n\n```json\n{\n  \"site\": {\n    \"theme\": \"custom\",\n    \"customTheme\": {\n      \"name\": \"custom\",\n      \"background\": \"bg-purple-900\",\n      \"text\": \"text-white\",\n      \"accent\": \"text-yellow-400\"\n    }\n  }\n}\n```\n\n### SEO Configuration\n\n```json\n{\n  \"site\": {\n    \"seo\": {\n      \"keywords\": [\"blog\", \"tech\", \"programming\"],\n      \"ogImage\": \"/og-image.jpg\",\n      \"twitterCard\": \"summary_large_image\"\n    }\n  }\n}\n```\n\n### Analytics Integration\n\n```json\n{\n  \"site\": {\n    \"analytics\": {\n      \"googleAnalytics\": \"GA_MEASUREMENT_ID\",\n      \"plausible\": \"domain.com\"\n    }\n  }\n}\n```\n\n## 📊 Scripts\n\n| Command | Description |\n|---------|-------------|\n| `zyros init \u003cname\u003e` | Initialize new project |\n| `zyros dev` | Start development server |\n| `zyros build` | Build for production |\n| `zyros content create` | Create new post |\n| `zyros content list` | List all posts |\n| `zyros validate` | Validate project |\n| `zyros optimize` | Optimize assets |\n| `zyros deploy \u003cplatform\u003e` | Deploy to platform |\n\n## 🚀 Deployment\n\n### Vercel (Recommended)\n```bash\nnpm install -g vercel\nzyros deploy vercel --prod\n```\n\n### Netlify\n```bash\nnpm install -g netlify-cli\nzyros deploy netlify --prod\n```\n\n### GitHub Pages\n```bash\nzyros deploy github\n```\n\n### Manual Deployment\n1. Run `zyros build`\n2. Upload the `dist/` folder to your hosting provider\n3. Configure your server to serve `index.html` for all routes\n\n## 🔍 Validation \u0026 Optimization\n\n### Content Validation\n```bash\n# Validate your content structure\nzyros validate\n\n# Check for common issues\n# - Missing required fields\n# - Duplicate slugs\n# - Invalid markdown syntax\n# - SEO recommendations\n```\n\n### Image Optimization\n```bash\n# Optimize all images\nzyros optimize\n\n# Optimize images only\nzyros optimize --images\n\n# Generate WebP versions\nzyros optimize --webp\n```\n\n## 📊 Analytics Dashboard\n\nAccess your site's analytics to understand your audience:\n\n- **Page Performance** - Views, reading time, engagement\n- **Search Insights** - Popular queries and trends\n- **User Behavior** - Theme preferences, navigation patterns\n- **Content Analytics** - Most popular posts and categories\n\nAll analytics are privacy-first and stored locally.\n\n## 🗺️ Roadmap\n\n### ✅ Recently Added (v2.1.4)\n- [x] **NPM Package** - Install globally or use with npx\n- [x] **CLI Tool** - Complete command-line interface with proper termination\n- [x] **Template System** - 5 complete starter templates (Default, Portfolio, Documentation, Business, Minimal)\n- [x] **Content Validation** - Validate structure and content\n- [x] **Image Optimization** - Automatic image processing\n- [x] **One-click Deployment** - Deploy to multiple platforms\n- [x] **TypeScript Support** - Full type definitions\n- [x] **Enhanced Reliability** - Fixed critical file filtering issues\n- [x] **Windows Compatibility** - Improved cross-platform support\n- [x] **Command Termination** - All CLI commands now properly exit\n- [x] **Complete Template System** - All templates working with proper configurations\n\n### 🚧 Coming Soon (v2.1)\n- [ ] **Plugin System** - Extensible architecture\n- [ ] **CMS Integration** - Headless CMS support\n- [ ] **Multi-language Support** - i18n capabilities\n- [ ] **Advanced SEO** - Schema markup, meta optimization\n- [ ] **Performance Monitoring** - Real-time metrics\n- [ ] **Comment System** - GitHub Issues integration\n\n### 🔮 Future Plans (v3.0+)\n- [ ] **Visual Editor** - WYSIWYG content editing\n- [ ] **Collaboration Tools** - Multi-author support\n- [ ] **E-commerce Integration** - Product pages\n- [ ] **Advanced Analytics** - Detailed insights\n- [ ] **Mobile App** - Content management on the go\n\n## 🤝 Contributing\n\nWe welcome contributions! Here's how you can help:\n\n1. **Fork the repository**\n2. **Create a feature branch** (`git checkout -b feature/amazing-feature`)\n3. **Commit your changes** (`git commit -m 'Add amazing feature'`)\n4. **Push to the branch** (`git push origin feature/amazing-feature`)\n5. **Open a Pull Request**\n\n### Development Setup\n\n```bash\n# Clone the repository\ngit clone https://github.com/zyrasoftware/zyros.git\ncd zyros\n\n# Install dependencies\nnpm install\n\n# Start development\nnpm run dev\n\n# Run tests\nnpm test\n\n# Build package\nnpm run build\n```\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## 🙏 Acknowledgments\n\n- Built with [Next.js](https://nextjs.org/)\n- Styled with [Tailwind CSS](https://tailwindcss.com/)\n- Markdown rendering by [react-markdown](https://github.com/remarkjs/react-markdown)\n- CLI powered by [Commander.js](https://github.com/tj/commander.js)\n- Beautiful terminal output with [Chalk](https://github.com/chalk/chalk)\n\n## 📞 Support\n#SOON\n- 📖 [Documentation]()\n- 💬 [Community Discussions](https://github.com/zyrasoftware/zyros/discussions)\n- 🐛 [Report Issues](https://github.com/zyrasoftware/zyros/issues)\n- 📧 [Email Support](mailto:zyrasoftwaredev@gmail.com)\n\n---\n\n**Made with ❤️ by Zyra Software**\n\n*Transform your ideas into beautiful static sites with zyros*\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzyrasoftware%2Fzyros","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzyrasoftware%2Fzyros","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzyrasoftware%2Fzyros/lists"}