Skip to content

🎀 Add Comprehensive Marp Presentation for Forms Library #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# LambdaCurry Forms Library Documentation

This directory contains documentation and presentations for the LambdaCurry Forms Library.

## πŸ“‹ Contents

### Presentations

- **[forms-library-presentation.md](./forms-library-presentation.md)** - Comprehensive Marp presentation showcasing the library architecture, design decisions, and benefits

## 🎀 Viewing the Presentation

The presentation is built using [Marp](https://marp.app/), a markdown-based presentation framework.

### Option 1: VS Code with Marp Extension

1. Install the [Marp for VS Code](https://marketplace.visualstudio.com/items?itemName=marp-team.marp-vscode) extension
2. Open `forms-library-presentation.md` in VS Code
3. Use the preview pane to view the slides
4. Export to PDF, HTML, or PowerPoint as needed

### Option 2: Marp CLI

```bash
# Install Marp CLI
npm install -g @marp-team/marp-cli

# Convert to HTML
marp docs/forms-library-presentation.md --html

# Convert to PDF
marp docs/forms-library-presentation.md --pdf

# Convert to PowerPoint
marp docs/forms-library-presentation.md --pptx

# Serve with live reload
marp docs/forms-library-presentation.md --server
```

### Option 3: Online Marp Editor

1. Copy the content of `forms-library-presentation.md`
2. Paste it into the [Marp online editor](https://web.marp.app/)
3. View and export as needed

## 🎨 Presentation Features

The presentation includes:

- **Custom styling** with gradient backgrounds and professional typography
- **Code syntax highlighting** for TypeScript examples
- **Two-column layouts** for comparing concepts
- **Architecture diagrams** using ASCII art
- **Interactive examples** and real code snippets
- **Comprehensive coverage** of:
- Library architecture and design decisions
- Component anatomy and patterns
- React Router and Remix Hook Form integration
- Storybook testing strategies
- Accessibility features
- Developer experience benefits

## πŸ“š Additional Resources

- [Main Library Documentation](../README.md)
- [Storybook Documentation](https://lambda-curry.github.io/forms/)
- [Component Patterns](.cursor/rules/form-component-patterns.mdc)

Loading
Loading