@fayz-ai/plugin-blog

中文文档
0.12.47发布于 2026/11/11MITTypeScriptES Module近 30 天下载 5242

[experimental] Fayz SDK — blog / articles plugin (website surface)

原始使用文档
文档目录4 节
  1. What's inside
  2. Install
  3. Usage
  4. Part of the Fayz SDK

@fayz-ai/plugin-blog

A headless blog surface — post list + article page — you drop into any Fayz website.

npm license

Status: beta — pre-1.0. Ships a public website surface (blog list + post detail) running on bundled mock/seed data, with a Supabase-backed provider seam included and evolving. No admin UI in M1 (the host owns website navigation). APIs may change before 1.0.

Marketing sites need a blog, and every one ends up rebuilt from scratch. plugin-blog is the reusable version: a headless, SEO-ready blog you compose into a Fayz website as a bundle of { manifest, Provider }. It ships the public read surface — a /blog list and a /blog/:slug article page — plus the data seam behind them, so the host site owns layout and navigation while the plugin owns posts.

It follows the "website plugin" (Model A) pattern: instead of a defineSaas plugin, createBlogPlugin returns a manifest (with public routes), an app-root Provider, and the resolved data provider. Drop the routes into your router, wrap your app in the Provider, and you have a blog.

What's inside

  • Public routes — GET /blog (list) and /blog/:slug (detail), both guard: "public", mounted under a configurable basePath. Their components load lazily, so a host that never mounts them (a storefront on the SDK's router adapter, a TanStack Start host) never downloads them — or the react-router they are written against
  • Components — BlogList, PostDetail, PostCard, AuthorAvatar, on their own door: import { BlogList } from '@fayz-ai/plugin-blog/components' (they are bound to react-router-dom; the main entry is router-free)
  • Hooks — useBlogPosts, usePost, and useBlogContext
  • Data seam — createSafeDataProvider picks createSupabaseBlogProvider when configured, else createMockBlogProvider seeded from your seed posts
  • SEO — per-page useSeo with og:site_name, plus organization + breadcrumb JSON-LD
  • Byline + i18n defaults — configurable defaultAuthor, siteName, and pt-BR list/back labels

Install

npm install @fayz-ai/plugin-blog

Peer deps: react, react-dom, react-router-dom. Runtime dep: @fayz-ai/core.

Usage

import { createBlogPlugin } from '@fayz-ai/plugin-blog'

const blog = createBlogPlugin({
  basePath: '/blog',
  siteName: 'Acme',
  defaultAuthor: { name: 'Equipe Acme' },
  seed: { posts: [/* ... */] },
})

// blog.manifest.routes -> spread into your website router
// wrap your app tree in <blog.Provider> so the routes resolve their data

Part of the Fayz SDK

A website surface plugin. Pairs with @fayz-ai/plugin-sites and the storefront/website scaffolds; complements @fayz-ai/plugin-payments in composing bespoke marketing sites from curated plugins.

版本与发布记录

@fayz-ai/plugin-blog 共发布 62 个版本,首次发布于 2026/07/13;过去 12 个月发布了 62 个版本。

版本发布日期距今
0.12.47latest2026/11/112 天前
0.12.462026/11/113 天前
0.12.452026/11/068 天前
0.12.442026/11/059 天前
0.12.432026/11/0410 天前
0.12.422026/10/3015 天前

其他发布通道:next → 0.9.0-next.1,canary → 0.12.42-canary.20261028153856。

关于 @fayz-ai/plugin-blog 的常见问题

@fayz-ai/plugin-blog 是什么?

[experimental] Fayz SDK — blog / articles plugin (website surface)

如何安装 @fayz-ai/plugin-blog?

在项目目录运行 npm install @fayz-ai/plugin-blog,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.0.0 || ^19.0.0)、react-dom(^18.0.0 || ^19.0.0)、lucide-react(>=0.400.0 <1.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@fayz-ai/plugin-blog 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@fayz-ai/plugin-blog 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@fayz-ai/plugin-blog 可以商用吗?

@fayz-ai/plugin-blog 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@fayz-ai/plugin-blog 的下载量有多少?

根据 npm 官方下载统计,@fayz-ai/plugin-blog 在 2026/10/15 – 2026/11/13 这 30 天内被下载 5,242 次,日均约 175 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@fayz-ai/plugin-blog 还在维护吗?

最新版本 0.12.47 发布于 2026/11/11(2 天前);至今共发布 62 个版本,其中过去 12 个月发布了 62 个;首次发布于 2026/07/13。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。