@readpress/wp-blog 1.0.7 → 1.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
# @readpress/wp-blog
|
|
2
2
|
|
|
3
|
-
A minimal, read-only headless WordPress blog adapter for modern web apps. Useful when you already have a web app and want to ship a fast, reliable blog using WordPress as your CMS.
|
|
3
|
+
A minimal, read-only headless WordPress blog adapter for modern web apps. Useful when you already have a web app and want to ship a fast, reliable blog using WordPress as your CMS.
|
|
4
4
|
|
|
5
5
|
- Fetch posts, authors, categories, and tags; includes post search
|
|
6
6
|
- Supports draft/private reads for preview flows with auth
|
|
7
|
-
- Framework-agnostic core with Next.js App Router examples
|
|
8
7
|
- Read-only API (no write/update operations)
|
|
8
|
+
- Next.js App Router docs and examples, with a framework-agnostic core
|
|
9
|
+
- Docs ready for AI agent workflows (Codex, Cursor, Claude)
|
|
9
10
|
|
|
10
11
|
## Requirements
|
|
11
12
|
|
|
@@ -38,7 +39,7 @@ WP_REST_ENDPOINT=/wp-json/wp/v2/posts
|
|
|
38
39
|
- Configure `classNameMap` to replace class names in post HTML fetched from WordPress into your app (e.g., replace Gutenberg block class names with Tailwind classes in Next.js).
|
|
39
40
|
|
|
40
41
|
## Quick start
|
|
41
|
-
See docs/quickstart.mdx
|
|
42
|
+
See [docs/quickstart.mdx](./docs/quickstart.mdx)
|
|
42
43
|
|
|
43
44
|
## AI-ready docs
|
|
44
45
|
|
|
@@ -49,13 +50,13 @@ Recommended:
|
|
|
49
50
|
- Or point your agent to the `docs/` folder in this repo on GitHub.
|
|
50
51
|
|
|
51
52
|
## Examples
|
|
52
|
-
-
|
|
53
|
-
-
|
|
54
|
-
-
|
|
53
|
+
- [examples/nextjs-blog](./examples/nextjs-blog/README.md)
|
|
54
|
+
- [examples/gutenberg-blocks-tailwind](./examples/gutenberg-blocks-tailwind/README.md)
|
|
55
|
+
- [examples/nextjs-post-components](./examples/nextjs-post-components/README.md)
|
|
55
56
|
|
|
56
57
|
## Advanced guides
|
|
57
58
|
|
|
58
|
-
- Drafts and preview:
|
|
59
|
-
- SEO in Next.js:
|
|
60
|
-
- Link rewriting:
|
|
61
|
-
- Class mapping (custom class names):
|
|
59
|
+
- Drafts and preview: [docs/guides/drafts-and-preview.mdx](./docs/guides/drafts-and-preview.mdx)
|
|
60
|
+
- SEO in Next.js: [docs/recipes/seo-nextjs.mdx](./docs/recipes/seo-nextjs.mdx)
|
|
61
|
+
- Link rewriting: [docs/content/link-rewriting.mdx](./docs/content/link-rewriting.mdx)
|
|
62
|
+
- Class mapping (custom class names): [docs/content/class-mapping.mdx](./docs/content/class-mapping.mdx)
|