內容簡介
Zipped Docs 將 WordPress 轉變為一個功能齊全的文件平台,適合用於產品文檔、知識庫、幫助中心及開發者文檔,提供高效的文檔管理與導航體驗。
【主要功能】
• 自訂文章類型:專用的 zipped_docs_doc 文章類型,將文檔與部落格文章分開
• 分類法:使用層級分類組織文檔,支持每篇文檔的排序
• 導航欄:固定位置的浮動導航欄,提供群組指示與預覽面板
• 章節引擎:基於 H1 的章節管理,支持平滑過渡與 URL 錨點同步
• 自動生成目錄:從標題標籤自動生成,可摺疊的部分與滾動監視
• 客戶端搜尋:即時頁面搜尋,支持鍵盤導航建議與內容高亮
外掛標籤
開發者團隊
原文外掛簡介
Zipped Docs transforms WordPress into a full-featured documentation platform. Perfect for product documentation, knowledge bases, help centers, and developer docs.
Key Features
Custom Post Type — Dedicated zipped_docs_doc post type keeps docs separate from blog posts.
Category Taxonomies — Organize docs with hierarchical categories, default category protection, per-doc ordering.
Navigation Rail — Fixed-position floating rail with group indicators, hover preview panel, dynamic content-boundary visibility.
Chapter Engine — H1-based chapter management with smooth transitions, URL hash sync, independent scroll tracking.
Hierarchical Table of Contents — Auto-generated from heading tags (H1-H6), collapsible sections, scroll-spy with IntersectionObserver.
Client-Side Search — Instant on-page search with keyboard-navigable suggestions, in-content highlighting, TOC filtering, REST API fallback.
Precomputed Doc Graph — Zero-latency page loads via cached data structures rebuilt on save. Single-query builder.
Reading Progress Bar — Optional per-chapter progress indicator at the top of each doc.
Breadcrumbs — Automatic breadcrumb navigation shows category > doc path.
Prev / Next Navigation — Sequential doc navigation through the category tree.
Related Articles — Auto-suggested related docs from the same category.
Fully Customizable — Theme color, typography, sidebar width, TOC depth, TOC colors, all adjustable from 8-tab Settings panel.
Shortcode — Simple [zippeddocs product="category-slug"] embeds documentation anywhere.
Gutenberg Compatible — Full block editor support for rich doc content.
REST API — Public search endpoint for headless or AJAX integration.
Custom Capabilities — Fine-grained roles: zipped_docs_editor role, read/create/edit/delete/manage permissions.
Uninstall Cleanup — Full data removal on deletion, with settings toggle and ZIPPED_DOCS_PRESERVE_DATA constant support.
Deactivation Flow — Branded modal with Keep Data / Remove All Data options.
Modular Admin JS — Custom modal system (ZippedDocsPopup), delete confirmations, keyboard-navigable dialogs.
Security Hardened — Stored XSS prevention, nonce sanitization, POST filtering, output escaping throughout.
Shortcode Examples
[zippeddocs product="category-slug"]
[zippeddocs product="express" doc_id="123"]
[zippeddocs product="storfox" toc_depth="4"]
Privacy
This plugin does not collect or transmit any personal data. All data stays on your server.
