Recipes · guide
Recipes
Current Apexify.js 6.0.0 documentation for Recipes.
Recipes (recipe-*.mdx in this folder) are goal-first walkthroughs: what you want on disk / in an API response, prerequisites, steps, and a full runnable snippet. They sit above copy-paste noise and below option-by-option manuals.
Feature guides (docs/03-feature-guides/) explain every flag. Recipes explain why this combination of APIs solves one product-shaped problem.
Start here
| Page | Purpose |
|---|---|
| Why ApexPainter exists — goals & stack | Problem Apexify solves, how the façade fits Node / buffers, when not to reach for it |
| What you can build | Idea catalog (products → APIs → guides) across canvas, images, text, GIF, charts, video, batch, save |
Before you copy code
- Start here — install,
ApexPainter, minimal PNG - Beginner guide — buffers, pitfalls, save
- Feature tracks — one map into every topic
Folder conventions
| Rule | Why |
|---|---|
| One recipe per file | Stable anchors; easier reviews |
| Name | recipe-<topic>.mdx (kebab-case) |
| Structure | Title → Goal → Prerequisites → Steps → Full example → See also |
| Anchor | {#recipe-<topic>} on the # title |
Published recipes
| Recipe | Builds |
|---|---|
| Social share card (PNG + disk) | Og-style 1200×630 card → save |
Extend this table whenever you add recipe-*.mdx files.
Related hubs
| Hub | Use |
|---|---|
| Feature guides | Depth per topic |
| Raster, batch & output | save, outPut, batch, pixels, path2d, detect, painter.image |
| Advanced overview | Scenes, composition, $ assets |