|
| 1 | +# LambdaCurry Forms Library Documentation |
| 2 | + |
| 3 | +This directory contains documentation and presentations for the LambdaCurry Forms Library. |
| 4 | + |
| 5 | +## 📋 Contents |
| 6 | + |
| 7 | +### Presentations |
| 8 | + |
| 9 | +- **[forms-library-presentation.md](./forms-library-presentation.md)** - Comprehensive Marp presentation showcasing the library architecture, design decisions, and benefits |
| 10 | + |
| 11 | +## 🎤 Viewing the Presentation |
| 12 | + |
| 13 | +The presentation is built using [Marp](https://marp.app/), a markdown-based presentation framework. |
| 14 | + |
| 15 | +### Option 1: VS Code with Marp Extension |
| 16 | + |
| 17 | +1. Install the [Marp for VS Code](https://marketplace.visualstudio.com/items?itemName=marp-team.marp-vscode) extension |
| 18 | +2. Open `forms-library-presentation.md` in VS Code |
| 19 | +3. Use the preview pane to view the slides |
| 20 | +4. Export to PDF, HTML, or PowerPoint as needed |
| 21 | + |
| 22 | +### Option 2: Marp CLI |
| 23 | + |
| 24 | +```bash |
| 25 | +# Install Marp CLI |
| 26 | +npm install -g @marp-team/marp-cli |
| 27 | + |
| 28 | +# Convert to HTML |
| 29 | +marp docs/forms-library-presentation.md --html |
| 30 | + |
| 31 | +# Convert to PDF |
| 32 | +marp docs/forms-library-presentation.md --pdf |
| 33 | + |
| 34 | +# Convert to PowerPoint |
| 35 | +marp docs/forms-library-presentation.md --pptx |
| 36 | + |
| 37 | +# Serve with live reload |
| 38 | +marp docs/forms-library-presentation.md --server |
| 39 | +``` |
| 40 | + |
| 41 | +### Option 3: Online Marp Editor |
| 42 | + |
| 43 | +1. Copy the content of `forms-library-presentation.md` |
| 44 | +2. Paste it into the [Marp online editor](https://web.marp.app/) |
| 45 | +3. View and export as needed |
| 46 | + |
| 47 | +## 🎨 Presentation Features |
| 48 | + |
| 49 | +The presentation includes: |
| 50 | + |
| 51 | +- **Custom styling** with gradient backgrounds and professional typography |
| 52 | +- **Code syntax highlighting** for TypeScript examples |
| 53 | +- **Two-column layouts** for comparing concepts |
| 54 | +- **Architecture diagrams** using ASCII art |
| 55 | +- **Interactive examples** and real code snippets |
| 56 | +- **Comprehensive coverage** of: |
| 57 | + - Library architecture and design decisions |
| 58 | + - Component anatomy and patterns |
| 59 | + - React Router and Remix Hook Form integration |
| 60 | + - Storybook testing strategies |
| 61 | + - Accessibility features |
| 62 | + - Developer experience benefits |
| 63 | + |
| 64 | +## 📚 Additional Resources |
| 65 | + |
| 66 | +- [Main Library Documentation](../README.md) |
| 67 | +- [Storybook Documentation](https://lambda-curry.github.io/forms/) |
| 68 | +- [Component Patterns](.cursor/rules/form-component-patterns.mdc) |
| 69 | + |
0 commit comments