wehub-resource-sync
44 lines
2.1 KiB
Markdown
44 lines
2.1 KiB
Markdown
# PPT Master Example Projects
|
|
|
|
> Curated example projects generated by PPT Master.
|
|
|
|
> Example artifacts are frozen snapshots of the workflow and capability boundary that generated them. Their `design_spec.md` and `spec_lock.md` files may retain rules that were later relaxed; they are historical evidence, not current SVG authoring authority. Use [`shared-standards.md`](../skills/ppt-master/references/shared-standards.md) for current required, forbidden, and conditional rules.
|
|
|
|
**[Browse all examples online](https://hugohe3.github.io/ppt-master/)** — the canonical catalog, powered by [`examples.json`](./examples.json). The JSON file is the source of truth for project metadata, tags, and slide listings; this README only documents folder structure.
|
|
|
|
## Project Structure
|
|
|
|
Each example follows this layout:
|
|
|
|
```
|
|
<project_name>/
|
|
├── design_spec.md # Design specification (human-readable)
|
|
├── spec_lock.md # Machine-readable execution contract
|
|
├── images/ # Image assets
|
|
├── notes/ # Speaker notes per page
|
|
├── svg_output/ # Original SVGs (with placeholders)
|
|
└── svg_final/ # Self-contained preview SVGs (icons + images embedded)
|
|
```
|
|
|
|
> Examples deliberately omit `sources/` (original PDFs / DOCX) and `exports/` (PPTX output) to keep repo size small. Real projects under `projects/` will have both.
|
|
|
|
## Preview locally
|
|
|
|
```bash
|
|
python -m http.server --directory examples/<project_name>/svg_final 8000
|
|
# visit http://localhost:8000
|
|
```
|
|
|
|
Or open any `svg_final/*.svg` directly in a browser / VS Code.
|
|
|
|
## Contributing
|
|
|
|
New or deliberately refreshed examples need (1) the standard structure above and (2) an entry in [`examples.json`](./examples.json) (`projects[]` array + bumped `stats`). Their SVGs should pass `python3 skills/ppt-master/scripts/svg_quality_checker.py`; existing frozen snapshots are not retroactively rewritten solely to match a newer authoring policy.
|
|
|
|
## Related
|
|
|
|
- [Quick Start](../README.md)
|
|
- [Workflow](../skills/ppt-master/SKILL.md)
|
|
- [Chart Templates](../skills/ppt-master/templates/charts/)
|
|
- [Icon Library](../skills/ppt-master/templates/icons/)
|