1 line
4.6 KiB
Markdown
1 line
4.6 KiB
Markdown
|
# pres-prvng\n\nAI-assisted presentation generated with [presgen](https://github.com/tools/presentation-generator).\n\n## Theme\n\n**rust-vibe** - Dark theme inspired by Rust and modern vibes\n\n## Structure\n\nThis presentation is organized as a modular Slidev project with the following structure:\n\n```plaintext\npres-prvng/\n├── .project-tools/ # Configuration and generated content\n│ ├── presentation.toml # Main configuration (edit this!)\n│ ├── data/ # Database storage\n│ ├── sections/ # Generated sections\n│ ├── variants/ # Presentation variants\n│ ├── exports/ # Export output\n│ └── backups/ # Configuration backups\n├── sections/ # User-created sections\n├── demos/ # Code demonstrations\n├── public/ # Images and assets\n│ ├── images/\n│ └── assets/\n├── README.md # This file\n├── slides-talk.md # Generated slides (talk variant)\n├── slides-pitch.md # Generated slides (pitch variant)\n└── presentation.toml # Presentation configuration\n```\n\n## Configuration\n\nEdit `.project-tools/presentation.toml` to customize:\n\n- **Metadata**: Title, author, date, keywords, description\n- **Content**: Asset paths, validation thresholds, content structure\n- **Theme**: Colors, typography, layout, animations\n- **Profiles**: Different presentation modes (talk, pitch, workshop, lightning)\n- **Export**: PDF/HTML settings\n\nThe configuration follows the [Presentation Guidelines](../guidelines/PRESENTATION_GUIDELINES.md) and includes built-in validation rules (P-CONTENT-*, P-DESIGN-*, P-CODE-*, etc.).\n\n## Quick Commands\n\n### Initialize\n\n```bash\npresgen init my-presentation --theme rust-vibe\n```\n\n### Generate Sections\n\n```bash\npresgen section "Rust Ownership" --layout two-cols\npresgen section "Live Demo" --layout demo\n```\n\n### Generate Variants\n\n```bash\npresgen variant --profile talk # Generate 30-45 min version\npresgen variant --profile pitch # Generate 5-10 min version\npresgen variant --profile workshop # Generate full workshop\n```\n\n### Validate\n\n```bash\npresgen validate slides-talk.md --profile talk\npresgen validate slides-talk.md --detailed\n```\n\n### Export\n\n```bash\npresgen export --profile talk --format pdf\npresgen export --profile pitch --format html --compress\n```\n\n### View Guidelines\n\n```bash\npresgen guidelines content\npresgen guidelines design --detailed\n```\n\n## Presentation Guidelines\n\nThis project includes validation against Presentation Design Guidelines:\n\n- **P-CONTENT-XXX**: Content guidelines (one message, bullet limits, structure)\n- **P-DESIGN-XXX**: Design guidelines (whitespace, contrast, fonts)\n- **P-CODE-XXX**: Code display guidelines (size limits, highlighting)\n- **P-AUDIENCE-XXX**: Audience guidelines (terminology, jargon context)\n- **P-A11Y-XXX**: Accessibility guidelines (readability, color-blind safe)\n\nRun `presgen guidelines` to see all rules.\n\n## Profiles\n\nThis presentation includes multiple profiles for different contexts:\n\n- **talk** (30-45 min): Full technical presentation for developers\n- **pitch** (5-10 min): Quick pitch for executives\n- **workshop** (2-4 hours): Interactive workshop with exercises\n- **lightning** (5 min): Lightning talk format\n\nEdit the `[profiles]` section in `presentation.toml` to customize.\n\n## Next Steps\n\n1. **Edit metadata**: Update title, author, and contact info in `presentation.toml`\n2. **Create sections**: Use `presgen section` to add content\n3. **Customize colors**: Adjust theme colors in `presentation.toml`\n4. **Add assets**: Place images in `public/images` and demos in `demos/`\n5. **Generate slides**: Use `presgen variant` to create presentations\n6. **Validate**: Run `presgen validate` to check guidelines compliance\n7. **Export**: Use `presgen export` to generate PDF/HTML\n\n## Theme Details: rust-vibe
|