Description
Yukdigitalz Knowledge Base is a lightweight, secure, and accessible documentation plugin for WordPress. Designed for enterprise-level performance and premium modern aesthetics, it provides a seamless repository-ready system to publish, manage, and interact with your technical resources.
In addition to traditional Knowledge Base grids and navigation, Yukdigitalz Knowledge Base is equipped with a state-of-the-art RAG AI Chat Assistant drawer (SaaS style). The AI assistant utilizes Retrieval-Augmented Generation (RAG) to scan your published articles, retrieve matching context, and reply contextually. It leverages the native WordPress AI Client. To protect your server from quota exhaustion, it features robust Hashed IP Rate Limiting and client-side anti-spam cooldown mechanisms.
Features
- SaaS-Style AI Chat Assistant (RAG): A floating spark button slides out a contextual chat drawer. The assistant automatically queries the knowledge base (
yukdigitalz_kb_doc), inserts matching content records as context, and replies contextually using AI. - WordPress Native AI Client: Seamlessly hooks into
wp_ai_client_promptto leverage AI options configured in your WP dashboard. - AI Chat Rate Limiting & Anti-Spam Security: Built-in privacy-safe hashed IP request tracking via WordPress Transients (limits maximum queries per hour per user) and client-side cooldown locks.
- Premium Performance Layouts: Built entirely using zero-dependency, modern Vanilla JS and lightweight clean CSS (fully compatible with Gutenberg, Classic Editor, and Block/FSE Themes).
- AJAX Live Search: Accessible instant searching matching post titles, categories, and article snippets with a loading indicator.
- Collapsible Accordion Sidebar: Interactive, accessible list of categories and documents in the sidebar that preserves expansion states.
- Automatic Table of Contents (TOC): Dynamically parses
h2andh3tags inside article content to render a floating index widget. - Helpfulness Feedback Widget: AJAX-based user voting (“Was this article helpful?”) with custom cookie session locks to prevent spam ratings.
- Breadcrumbs Navigation: Automated microdata-ready hierarchical path links at the top of individual documentation pages.
- Enterprise Customizer Settings: A premium, tabbed dashboard options page allowing you to configure custom base slugs, primary hover colors, rating widgets, TOCs, Q&A Comments toggle, and rate limit parameters.
Installation
- Upload the plugin files to the
/wp-content/plugins/yukdigitalz-knowledge-basedirectory, or install through the WordPress Plugins dashboard. - Activate the plugin.
- Save options under Settings > Yukdigitalz KB in your admin dashboard to flush rewrite rules and initialize custom paths.
- Insert the
[yukdigitalz_kb]shortcode on any Page to display the main Knowledge Base category grid card portal. - Create categories under Yukdigitalz KB > Categories and write documentation posts.
FAQ
-
Can I customize the colors to match my brand?
-
Yes. Navigate to Settings > Yukdigitalz KB > Styling Options to customize primary, hover transition, and accent highlight colors via color pickers.
-
How does the AI Assistant retrieve information?
-
When a user asks a question, the plugin performs an internal
WP_Querysearch on the custom post typeyukdigitalz_kb_doc. The top 3 matching articles are injected directly into the Gemini model instructions as ground-truth context. -
Can I override templates in my child theme?
-
Yes. Copy any template file from the plugin’s
templates/folder and paste it into ayukdigitalz-kb/folder inside your active theme directory to override layouts safely.
Reviews
There are no reviews for this plugin.
Contributors & Developers
“Yukdigitalz Knowledge Base” is open source software. The following people have contributed to this plugin.
ContributorsTranslate “Yukdigitalz Knowledge Base” into your language.
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
Changelog
1.0.0
- Initial release.
- Added hierarchical CPT and taxonomy registration.
- Added AJAX Live Search, helpfulness rating, and automatic Table of Contents.
- Added SaaS-style right-side slide-over RAG AI Chat Assistant drawer.
- Added hashed IP rate limiting and 2-second anti-spam cooldown lock to the AI Chat.
