Skip to content

AI assistants

Agents know StPageFlip and react-pageflip, and this library is neither, so from memory they write against an API that isn’t there. Copy whichever block below fits and you’re done.

prompt
Read https://openpageflip.shittylittleapps.com/_llms-txt/guides.txt before writing any code that uses OpenPageFlip. Follow those docs rather than what you know about StPageFlip or page-flip; the API is different.

CLAUDE.md, AGENTS.md, .github/copilot-instructions.md, a Cursor rule - whichever file your agent reads at the start of a session. Then you don’t have to say it again.

AGENTS.md
## OpenPageFlip
Page-flip effect for HTML content: `@openpageflip/core` (plain JavaScript) and `@openpageflip/react` (React 19).
It is not StPageFlip or page-flip: the API is different, so read the docs before writing code.
- Guides and examples: https://openpageflip.shittylittleapps.com/_llms-txt/guides.txt
- Everything, API reference included: https://openpageflip.shittylittleapps.com/llms-full.txt

For tools with a docs-URL setting (Cursor’s, for one), this is the one to paste:

llms.txt
https://openpageflip.shittylittleapps.com/llms.txt

Every page here is also served as Markdown, generated from the same source at every build. That index links to the guides (the quick starts and the examples, without the API reference) and to everything, API reference included. Tools that index a whole site can take https://openpageflip.shittylittleapps.com and will find the same pages.