whyml

WhyML Documentation

Welcome to the comprehensive WhyML documentation. This directory contains detailed guides, API references, and examples for using WhyML - the Advanced YAML Manifest System.

📚 Documentation Structure

Getting Started

Installation Guide - Install and set up WhyML
Quick Start - Get up and running in minutes
Basic Concepts - Understand WhyML fundamentals

CLI Reference

CLI Commands - Complete CLI command reference
whyml run - Development server commands
whyml convert - Format conversion commands
whyml generate - Artifact generation commands

Manifest Format

Manifest Schema - Complete manifest specification
Template Variables - Using variables and templating
Inheritance - Template inheritance system
Styling - CSS and style management

Converters

HTML Converter - Generate semantic HTML
React Converter - Create React components
Vue Converter - Generate Vue.js components
PHP Converter - Generate PHP classes

Application Generation

Progressive Web Apps (PWA) - Build PWAs
Single Page Applications (SPA) - Create SPAs
Mobile Apps (APK) - Generate mobile apps
Desktop Apps (Tauri) - Build desktop applications
Docker Containers - Containerization

Server & Deployment

Development Server - Local development setup
Production Deployment - Production configurations
Caddy Integration - Web server setup
Environment Configuration - Environment management

Advanced Topics

Web Scraping - Website to manifest conversion
API Integration - REST API and WebSocket support
Real-time Features - Live reload and collaboration
Custom Extensions - Extend WhyML functionality

Examples & Tutorials

Basic Examples - Simple usage examples
Advanced Tutorials - Step-by-step guides
Sample Projects - Complete project examples
Best Practices - Recommended patterns

API Reference

Python API - Python library reference
REST API - HTTP API endpoints
WebSocket API - Real-time communication

Contributing

Development Guide - Set up development environment
Architecture Overview - System design
Testing Guide - Running and writing tests

New to WhyML?

Start with Installation Guide
Follow the Quick Start
Try the Basic Examples

Building Applications?

Web Apps: PWA Guide → SPA Guide
Mobile Apps: APK Generation
Desktop Apps: Tauri Guide
Deployment: Production Guide

Converting Existing Code?

From HTML: Web Scraping
To React: React Converter
To Vue: Vue Converter

Need Help?

📱 Command Quick Reference

# Development server
whyml run -f manifest.yaml --watch
whyml run -f test-manifest.yaml --watch

# Convert formats  
whyml convert --from manifest.yaml --to output.html -as spa

# Generate applications
whyml generate pwa -f manifest.yaml -o ./pwa-app
whyml generate docker -f manifest.yaml -o ./docker-config

# Production deployment
whyml run -f manifest.yaml --port 443 --host yourdomain.com --tls-provider letsencrypt

🔗 External Resources

Last Updated: January 2025

Version: 1.0.1+

License: Apache 2.0

This site is open source. Improve this page.