malta-slides/AGENTS.md

AGENTS.md - Agent Guidelines for malta-slides-marp

This project builds a presentation deck for Marp based on Markdown files.

Agent Restrictions

• Agent NEVER runs commands on its own except changing files INSIDE THIS FOLDER, never any other then this

Build Commands

• npm run build - Build slides from Markdown using Marp
• npm run watch - Watch mode for live preview during development
• npm run export - Export slides to PDF/HTML formats

Test Commands

• npm test - Run all tests
• npm run test:watch - Run tests in watch mode
• npm run test -- --testNamePattern="specific test name" - Run single test

Code Style Guidelines

File Structure

• Use slides/ directory for Markdown slide files
• Use assets/ for images and media files
• Use themes/ for custom Marp themes

Naming Conventions

• Slide files: 01-intro.md, 02-content.md (numbered prefix)
• Images: snake_case.jpg or kebab-case.jpg
• Themes: custom-theme.css

Markdown Style

• Use ATX-style headers (# ## ###)
• Consistent code block language identifiers
• Frontmatter for slide metadata (title, theme, etc.)

Error Handling

• Validate Marp syntax before build
• Check for missing assets before export
• Log build errors with file paths and line numbers

Git Workflow

• Commit slide changes with descriptive messages (ALWAYS lowercase)
• Use feature branches for major slide revisions
• Tag releases with version numbers