Helpora – Knowledge Base, Docs & Documentation
| 开发者 | sandcircuit |
|---|---|
| 更新时间 | 2026年11月2日 13:49 |
| PHP版本: | 8.1 及以上 |
| WordPress版本: | 7.1 |
| 版权: | GPLv2 or later |
| 版权网址: | 版权信息 |
详情介绍:
📚 The knowledge base plugin that shows you what readers need
Helpora turns WordPress into a knowledge base, documentation site, help center, or internal handbook. Readers find answers in seconds with instant search, and you see exactly which articles help and what people searched for but couldn't find.
Set it up in two minutes, write in the block editor you already know, and keep everything on your own site.
- 🔍 Instant search that ranks: results as readers type, typo suggestions, and partial-word matching.
- 🗂️ Drag-and-drop structure: nest articles three levels deep and reorder everything from one screen.
- 📈 Insights that suggest actions: failed searches, helpful votes, and a one-click Create article for missing topics.
- 🧩 Multiple knowledge bases, free: one docs site for several products, teams, or audiences.
- ✍️ Blocks made for docs: callouts, steps, code snippets, tabs, FAQs, and lightbox screenshots.
- 🔒 Private and role-based articles: public, logged-in only, or chosen roles.
- 🎨 Fits any theme: block and classic themes, light and dark mode, your brand colour.
- Product and plugin makers: user guides, getting-started docs, and release notes.
- SaaS and support teams: a self-service help center that answers repeat questions before they reach your inbox.
- Companies and agencies: an internal wiki or team handbook, visible only to logged-in staff or chosen roles.
- Stores and services: an FAQ and help pages for shipping, returns, and accounts.
- A dedicated search index that weights titles over headings over body text.
- Instant results as readers type, grouped by category, with matched words highlighted.
- Finds partial words ("inst" finds "Installation") and suggests fixes for typos.
- Works without JavaScript, and never shows restricted articles to the wrong reader.
- Views, searches, and "Was this helpful?" votes, stored on your own site.
- Failed searches shows what readers looked for and didn't find, with a one-click Create article.
- Searches that found results nobody opened, a sign a title doesn't use readers' words.
- Export any report to CSV.
- No IP addresses, accounts, or browser details are stored.
- Articles nest three levels deep and reorder from one tree screen, by mouse or keyboard.
- Categories and tags, with icons and colours, for the docs home.
- Spaces: separate knowledge bases on one site, each with its own docs home, categories, and search.
- Quick edit for title, slug, status, categories, visibility, and attachments without opening the editor.
- A docs home (cards, list, or full tree) you edit like any page, plus category pages and article pages with a docs tree, breadcrumbs, table of contents, and previous/next links.
- Works with block themes and classic themes, and every template can be overridden from your theme.
- Light, dark, or automatic colour mode, with your brand colour.
- Clean URLs, and structured data search engines understand:
TechArticle,BreadcrumbList, andFAQPage. - Accessible: keyboard navigation, screen-reader labels, and contrast checked in both modes.
- Callout: Note, Tip, Important, Warning, and Danger boxes.
- Steps: numbered steps that renumber themselves.
- Code Snippet: a filename, language label, optional line numbers, and one-click copy (each can be turned off).
- Tabs: per-OS or per-plan instructions; readers' choices carry across pages.
- FAQ: questions that open on click, marked up for search engines.
- Lightbox Image: a screenshot readers can click to see full size, with an optional frame and caption.
- Docs Gallery: several screenshots in a tidy 1–4 column grid; readers open any one full size and page through the rest.
[helpora_search], [helpora_categories], [helpora_articles], [helpora_breadcrumbs], [helpora_toc].
🔒 Who can read what
Each article can be public, for logged-in users only, or for chosen roles. Restricted articles are hidden everywhere: listings, search, feeds, the REST API, and sitemaps.
🛠️ For developers
Template overrides from your theme, actions and filters for search, analytics, access, structured data, and templates, and WP-CLI commands (wp helpora reindex, wp helpora search).
安装:
- Install Helpora from Plugins → Add New, or upload the zip.
- Activate it. A notice offers a two-minute setup in three steps: where your docs live, a starter structure (product docs, internal handbook, or FAQ), and your colours.
- Your docs are at
/docs/. Arrange them under Helpora → Structure.
wp helpora reindex rebuilds the search index, and wp helpora search "query" tests ranking.屏幕截图:
常见问题:
Can I have more than one knowledge base?
Yes, for free. Turn on Use spaces under Helpora → Settings → General, and each product or team gets its own docs home, categories, and search.
Can I make a private or internal knowledge base?
Yes. Make any article visible to logged-in users only, or to chosen roles, for an internal wiki or staff handbook. Restricted articles are hidden from search, listings, feeds, the REST API, and sitemaps.
Is Helpora good for SEO?
Articles get clean URLs, breadcrumbs, and structured data (TechArticle, BreadcrumbList, and FAQPage for question-style articles), and public articles appear in your site's sitemap.
Does it work with my theme?
Yes, with block themes and classic themes. Helpora uses your theme's header, footer, and fonts. To change a template, copy it from the plugin's templates/ folder into a helpora/ folder in your theme.
Do I need to configure search?
No. Articles are indexed as you save them. If your database doesn't support full-text indexes, Helpora uses a slower matching method automatically.
Is analytics data sent anywhere?
No. Everything is stored in your own database. Raw events are deleted after the retention period (90 days by default). Daily totals are kept.
What happens to my articles if I deactivate the plugin?
Nothing. Content, settings, and data stay. Deleting the plugin also keeps everything, unless you first turn on Settings → Advanced → Delete data on uninstall.
Can I translate it?
Yes. All text is translatable; a template is in languages/helpora.pot.
Where is the source code for the JavaScript?
In the plugin's src/ folder. The files in build/ are compiled from it with @wordpress/scripts: run npm install, then npm run build. The open-source libraries included in the build, and their licences, are listed in third-party-licenses.txt.
更新日志:
1.0.0
- First release: articles with nesting and visibility; the Structure, Articles, Categories, Tags, Insights, and Settings screens; docs templates for block and classic themes; instant search with its own index; analytics with failed-search reports; helpfulness votes; a setup wizard.
- Blocks: five for building docs pages (with matching shortcodes) and seven for writing them: Callout, Steps, Code Snippet, Tabs, FAQ, Lightbox Image, and Docs Gallery, plus five article starters.