SAAI Knowledge

تفصیل

SAAI Knowledge adds three purpose-built content types to WordPress — FAQ, Knowledge Base, and Glossary — with the structure, navigation, and structured data that both readers and AI crawlers expect.

Knowledge Base

• Two-column layout: category sidebar + article, with automatic ancestor-term navigation
• Table of contents generated from your article’s headings, with scroll-spy highlighting
• Breadcrumbs with BreadcrumbList structured data
• Works with block themes and classic themes alike

FAQ

• Accordion display built on the core Accordion block — no extra JavaScript framework
• Each question gets its own page (question as heading, answer directly below) with QAPage structured data; the archive gets FAQPage structured data
• Server-rendered content: the answer is always present in the initial HTML, so JavaScript-averse crawlers see it too

Glossary

• A–Z / Japanese (五十音) index block, sorted by reading
• Automatic term linking across your site’s content, with a tooltip preview on hover/tap
• DefinedTerm structured data on each term’s page

Live search

• A single search block that queries FAQ, Knowledge Base, and Glossary content and groups results by type as you type

Built for AI / RAG pipelines

• Every FAQ/KB/Glossary page is available as clean Markdown via ?format=markdown
• A Markdown index of your whole knowledge base, published for AI crawlers
• If you run Yoast SEO, Rank Math, or All in One SEO, SAAI Knowledge fills in their llms.txt descriptions for these pages automatically
• A REST export endpoint with incremental sync (modified_after), plus a full-dump JSONL/CSV download from the admin screen — ideal for feeding a support chatbot or RAG index
• The Markdown output, llms.txt index, and SEO-plugin integration are controlled by a single setting; the REST export endpoint and admin download aren’t affected by it and are always available (the REST endpoint only ever returns already-public content; the admin download requires the same capability as the rest of Settings)

Extensible

Every automatic behavior (auto-linking, structured data, and the Markdown/llms.txt output) is controlled from Settings, and the plugin exposes saai_* actions/filters so other plugins and themes can customize or extend it.

Source code and build process

SAAI Knowledge is developed in the open. The complete, human-readable source — including the un-minified JavaScript and SCSS under src/ that the compiled files under build/ are generated from — is maintained at:

https://github.com/shinobiashi/saai-knowledge

The free plugin is the plugins/saai-knowledge/ directory of that repository.

The build uses @wordpress/scripts (webpack + Babel) and needs Node.js and npm; the project’s CI builds with Node.js 24. To reproduce the compiled files from source:

1. git clone https://github.com/shinobiashi/saai-knowledge.git
2. cd saai-knowledge
3. npm install

4. npm run build

   npm run build compiles plugins/saai-knowledge/src/** into plugins/saai-knowledge/build/**. No third-party JavaScript library is bundled: the only module the front-end scripts import is @wordpress/interactivity, which WordPress itself provides at runtime.

Looking for WooCommerce integration?

SAAI Knowledge for WooCommerce, a companion add-on that links FAQ/KB/Glossary content to products and product categories and displays it on product pages, is planned as a separately sold, optional purchase — it isn’t available yet and is not required to use this plugin.