initial project setup for hdm dateiformate slides

2025-12-14 08:19:11 +01:00
commit 8005f8c280
9 changed files with 5102 additions and 0 deletions
@@ -0,0 +1,132 @@
+# HdM - Dateiformate, Speichermedien und Schnittstellen
+
+## Creating Slides
+
+### Basic Slide Structure
+
+Slides are written in Markdown and separated by `---`:
+
+```markdown
+---
+marp: true
+theme: uncover
+paginate: true
+---
+
+# Slide Title
+
+Content here
+
+---
+
+# Next Slide
+
+More content
+```
+
+### Frontmatter
+
+Configure slide settings at the top:
+
+```yaml
+---
+marp: true
+theme: uncover
+paginate: true
+backgroundColor: #fff
+title: My Presentation
+---
+```
+
+### Themes
+
+Use built-in themes:
+- `default`
+- `gaia`
+- `uncover`
+
+Or create custom themes in `themes/` directory.
+
+### Images and Assets
+
+Place images in `assets/` directory and reference them:
+
+```markdown
+![Alt text](assets/image.jpg)
+```
+
+## Custom Themes
+
+Create custom themes in `themes/` directory:
+
+```css
+/* @theme custom-theme */
+
+@import-theme "gaia";
+
+section {
+  background-color: #f0f8ff;
+  color: #2c3e50;
+}
+
+h1 {
+  color: #3498db;
+}
+```
+
+Apply custom theme in frontmatter:
+```yaml
+---
+marp: true
+theme: custom-theme
+---
+```
+
+## Development Workflow
+
+1. Edit slide files in `slides/` directory
+2. Use `npm run dev` for live preview
+3. Make changes and see updates automatically
+4. Export final version with `npm run export:pdf`
+
+## Makefile Commands
+
+Alternative commands using Make:
+
+```bash
+make build      # Build slides
+make dev        # Start development server
+make pdf        # Export to PDF
+make html       # Export to HTML
+make watch      # Watch for changes
+make clean      # Remove generated files
+make deploy     # Deploy slides to server
+```
+
+## Tips
+
+- Use `---` to separate slides
+- Frontmatter controls global settings
+- Images should be in `assets/` directory
+- Custom themes extend built-in themes
+- PDF export requires Chrome/Chromium
+
+## Troubleshooting
+
+- **PDF export fails**: Ensure Chrome/Chromium is installed
+- **Server not starting**: Check if port 8080 is available
+- **Styles not applying**: Verify theme file paths
+- **Images not loading**: Check relative paths from slides directory
+
+## Contributing
+
+1. Follow the file structure conventions
+2. Use numbered prefixes for slide files
+3. Test builds before committing
+4. Keep commit messages lowercase and descriptive
+
+## License
+
+This project is licensed under [Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)](https://creativecommons.org/licenses/by-sa/4.0/).
+
+This project uses Marp which is MIT licensed.