update agents md to sync with makefile and readme
This commit is contained in:
17
AGENTS.md
17
AGENTS.md
@@ -7,8 +7,10 @@ This project builds a presentation deck for Marp based on Markdown files.
|
|||||||
|
|
||||||
## Build Commands
|
## Build Commands
|
||||||
- `npm run build` - Build slides from Markdown using Marp
|
- `npm run build` - Build slides from Markdown using Marp
|
||||||
|
- `npm run dev` - Start development server at http://localhost:8080
|
||||||
- `npm run watch` - Watch mode for live preview during development
|
- `npm run watch` - Watch mode for live preview during development
|
||||||
- `npm run export` - Export slides to PDF/HTML formats
|
- `npm run export:pdf` - Export slides to PDF format
|
||||||
|
- `npm run export:html` - Export slides to HTML format
|
||||||
|
|
||||||
## Test Commands
|
## Test Commands
|
||||||
- `npm test` - Run all tests
|
- `npm test` - Run all tests
|
||||||
@@ -23,7 +25,7 @@ This project builds a presentation deck for Marp based on Markdown files.
|
|||||||
- Use `themes/` for custom Marp themes
|
- Use `themes/` for custom Marp themes
|
||||||
|
|
||||||
### Naming Conventions
|
### Naming Conventions
|
||||||
- Slide files: `01-intro.md`, `02-content.md` (numbered prefix)
|
- Slide files: `index.md`, `additional-slides.md` (descriptive names)
|
||||||
- Images: `snake_case.jpg` or `kebab-case.jpg`
|
- Images: `snake_case.jpg` or `kebab-case.jpg`
|
||||||
- Themes: `custom-theme.css`
|
- Themes: `custom-theme.css`
|
||||||
|
|
||||||
@@ -40,4 +42,13 @@ This project builds a presentation deck for Marp based on Markdown files.
|
|||||||
### Git Workflow
|
### Git Workflow
|
||||||
- Commit slide changes with descriptive messages (ALWAYS lowercase)
|
- Commit slide changes with descriptive messages (ALWAYS lowercase)
|
||||||
- Use feature branches for major slide revisions
|
- Use feature branches for major slide revisions
|
||||||
- Tag releases with version numbers
|
- Tag releases with version numbers
|
||||||
|
|
||||||
|
## Makefile Commands
|
||||||
|
- `make build` - Build slides from Markdown
|
||||||
|
- `make dev` - Start development server
|
||||||
|
- `make watch` - Watch for changes and rebuild
|
||||||
|
- `make pdf` - Export slides to PDF
|
||||||
|
- `make html` - Export slides to HTML
|
||||||
|
- `make clean` - Remove generated files
|
||||||
|
- `make install` - Install dependencies
|
||||||
Reference in New Issue
Block a user