AI assistants
Most assistants have seen StPageFlip and react-pageflip, and honestly that’s the problem: this library isn’t either of them. The names are different and there’s no compatibility layer, so an agent working from memory writes against an API that isn’t there. The fix is just pointing it at these docs before it writes anything.
The docs as plain text
Section titled “The docs as plain text”Every page here is also served as Markdown, generated from the same source at every build, so an agent can read it without scraping HTML.
https://openpageflip.shittylittleapps.com/llms.txt: the index. A short description and links to the other two. If you’re not sure which to give it, give it this one.https://openpageflip.shittylittleapps.com/_llms-txt/guides.txt: the quick starts and the examples, without the API reference. Small enough to read whole, and enough to build a book from.https://openpageflip.shittylittleapps.com/llms-full.txt: everything, API reference included.
Tools that index docs from a URL (Cursor’s docs setting, for one) can be given the site address, https://openpageflip.shittylittleapps.com, and will find the same pages.
Tell it once
Section titled “Tell it once”Put this in the file your agent reads at the start of every session - CLAUDE.md, AGENTS.md, .github/copilot-instructions.md, a Cursor rule, whichever yours is - and you don’t have to say it again.
## 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.txtOr ask once
Section titled “Or ask once”For a one-off, a prompt that starts with the docs does the same job. Fill in the bits in angle brackets.
Read https://openpageflip.shittylittleapps.com/_llms-txt/guides.txt and then add an OpenPageFlip book to <the page> whose pages are <what the pages are>. Follow those docs rather than what you know about StPageFlip or page-flip; the API is different.