AssistCamp - Documentation/Knowledgebase Plugin
| 开发者 | imtiazrayhan |
|---|---|
| 更新时间 | 2026年7月28日 10:00 |
| PHP版本: | 7.4 及以上 |
| WordPress版本: | 6.9 |
| 版权: | GPLv2 or later |
| 版权网址: | 版权信息 |
详情介绍:
AssistCamp lets you build documentation sites inside WordPress. It works with both Full Site Editing (FSE) and classic themes, ships 10 purpose-built blocks, and provides an adaptive URL structure that adjusts automatically based on whether you have one or multiple knowledgebases.
Key Features
- FSE and Classic Theme Support - Works with block themes via HTML templates and classic themes via PHP templates. Themes can override templates by placing them in a
assistcamp/directory. - Adaptive URL Structure - Single KB mode uses
/docs/category/article/. When you add a second knowledgebase, URLs automatically switch to/docs/kb-name/category/article/. - 10 Custom Blocks - Server-rendered blocks for documentation layout: sidebar navigation, search, breadcrumbs, category grids, table of contents, and more.
- Live Search - REST API-powered search with real-time dropdown results and configurable result limits.
- Built-in Caching - Transient-based caching for search results, queries, and term counts with configurable duration.
- Customizable Slug - Change the base documentation URL from the default
/docs/to any slug you prefer. - Onboarding Wizard - Guided setup that creates your first knowledgebase, categories, and sample content.
- Customizer Integration - Layout and styling options for classic themes including sidebar position, typography, and search display.
- Translation Ready - Fully internationalized with a text domain for translation.
- Sidebar - Collapsible category and article navigation with doc counts
- Search Form - Live search with dropdown results and configurable delay
- Breadcrumb - Navigation breadcrumbs with customizable separator
- Archive Doc List - Filterable documentation list with sorting and pagination
- Category Grid - Display categories in a configurable grid layout
- Table of Contents - Auto-generated from headings with sticky positioning and smooth scroll
- Single Doc Content - Main documentation content area
- Doc Navigation - Previous/Next article navigation scoped to category or knowledgebase
- Date - Display last modified date with configurable format
- Knowledgebase Grid - Display all knowledgebases with doc counts and descriptions
- Product help centers
- Software documentation
- User guides and tutorials
- Internal knowledge bases
- FAQ sections
安装:
- Upload the plugin files to
/wp-content/plugins/assistcamp, or install through the WordPress plugins screen. - Activate the plugin through the Plugins screen.
- Follow the onboarding wizard to create your first knowledgebase and sample content.
- Add categories and start writing documentation under AssistCamp in the admin menu.
- Registers the
assistcamp_docpost type and related taxonomies - Sets up URL rewrite rules
- Initializes in single-knowledgebase mode
- Redirects to the onboarding wizard
常见问题:
How does the adaptive URL structure work?
AssistCamp detects how many knowledgebases you have:
- One knowledgebase:
/docs/getting-started/installation/ - Two or more:
/docs/product-name/getting-started/installation/
Does it work with classic themes?
Yes. AssistCamp includes PHP templates for classic themes and HTML block templates for FSE themes. It detects your active theme type and loads the appropriate templates. Classic themes also get Customizer options for layout and styling.
Can I override the templates?
Yes. Place template files in a assistcamp/ directory inside your theme to override the defaults.
Can I change the documentation URL?
Yes. Go to AssistCamp > Settings > General and change the documentation slug. The default is docs.
What caching does it use?
AssistCamp uses WordPress transients to cache search results, documentation queries, and term counts. You can configure the cache duration during setup or in settings. Cache is automatically invalidated when content is updated.
更新日志:
1.1.5
- Compliance: Remove Custom CSS option
- Security: Validate bookmarkable
kb/catquery args once in rewrite rules and read context viaget_query_var()instead of raw$_GET - Security: Harden settings save AJAX against nested or unexpected POST shapes
- Security: Taxonomy AJAX handlers return immediately after failed nonce or capability checks; pass explicit POST source into JSON field sanitization
- Fix: AJAX wrapper uses a stable nonce action string; remove unused GET helper from AJAX class
- Fix: Organize manager ordering AJAX stops after failed verification (nonce, capability, rate limit) and normalizes IDs with
absint() - Dev: Apply inline CSS sanitization at
wp_add_inline_style()call sites and drop the redundant helper
- Security: AJAX nonce verification for taxonomy endpoints; drop unused bypass helpers
- Security: Sanitize settings POST (map_deep) and taxonomy batch JSON inputs
- Security: Inline CSS for wp_add_inline_style() escaped with wp_strip_all_tags() at output (Customizer, KB grid block)
- Dev: PHPCS fixes in taxonomies and settings (nonces, sanitized input)
- Fix add wp_kses() at SVG echo points for PHPCS static analysis compliance
- Fix output escaping across all block render templates and classic theme templates
- Fix inline styles converted to wp_add_inline_style() for customizer and knowledgebase grid block
- Fix transient key prefixing for static analysis compliance
- Fix SVG output sanitized with wp_kses() in render helper methods
- Fix build_inline_styles() refactored for visible escaping at output point
- Remove all phpcs:ignore escape suppression comments
- Add configurable documentation URL slug
- Add onboarding wizard with sample content generation
- Add transient-based caching system
- Add Customizer options for classic themes
- Add data cleanup utility
- Improve search with REST API and rate limiting
- Initial release
- 10 custom blocks for documentation layout
- Adaptive URL structure for single and multi-knowledgebase modes
- FSE and classic theme template support
- Live search with real-time results
- Table of contents with sticky positioning