內容簡介
NV oOS Docs Hub 是一款專為 WordPress 設計的外掛，能夠發現、索引並呈現 Markdown 文件，提供類似 GitBook 的單頁應用介面。使用者可以輕鬆地將文檔嵌入網站，並享受無需遠端服務的本地化體驗。
【主要功能】
• 支援上傳 Markdown 文件至指定目錄
• 可選擇從公共 GitHub 倉庫導入文件
• 提供完整文本搜尋功能
• 支援 GitHub Flavored Markdown 語法
• 自訂提示框和代碼區塊
• 具備斷鏈檢測與修復建議
外掛標籤
開發者團隊
原文外掛簡介
NV oOS Docs Hub discovers, indexes, and renders Markdown documentation in a
GitBook-style single-page app: sidebar navigation, content area, and a
per-page table of contents. Embed it anywhere on your WordPress site via a
shortcode or Gutenberg block.
Out of the box it publishes documentation you upload yourself: drop
Markdown (.md) or text (.txt) files into
wp-content/uploads/nvoos-docs-hub/content/ (subfolders become sections),
rebuild the index, and they appear in the browser. No remote services are
involved.
Optional GitHub import (opt-in, off by default). Enable Remote
Repositories in the settings to import Markdown from any public GitHub
repository — no GitHub account required. This is a documentation-import
service: the plugin fetches files server-side, over HTTPS, and only from
api.github.com and raw.githubusercontent.com, then stores them in a
local cache on your server. No requests are made unless you enable the
setting, configure a repository, and trigger a rebuild. All scripts,
styles, fonts, and images are bundled locally — nothing is loaded from a
remote server. See External Services below for the full disclosure.
Key features:
Publish Markdown uploaded to wp-content/uploads/nvoos-docs-hub/content/ — zero configuration, zero remote calls
Optional import from public GitHub repositories with per-repo file/folder selection
Full-text search via the REST API with FlexSearch client-side fallback
GitHub Flavored Markdown: tables, task lists, fenced code blocks
Custom :::note, :::tip, :::warning, :::danger callout blocks
Syntax-highlighted code blocks, last-modified dates, and “Edit on GitHub” links
Broken-link detection with one-click fix suggestions (local sources)
Light and dark themes with CSS custom properties
Two-layer cache (filesystem + WordPress transients)
Async chunked rebuilds with a live progress panel — no more long single-request builds
WP-CLI support: wp nvoos-docs rebuild / clear / status
Nightly cron rebuild; also triggered on plugin activate/deactivate
Indexed pages included in the WordPress sitemap
[nvoos_docs] shortcode and nvoos/docs-hub Gutenberg block
Optional NV oOS integration. If the NV oOS base plugin
(https://github.com/nvdigitalsolutions/mcp-ai-wpoos) is active, the addon
additionally auto-discovers the docs/ folders of the base plugin and every
installed addon, and surfaces rebuild progress in the base plugin’s cron-status
drawer.
Shortcode
[nvoos_docs section="base" theme="light" search="1" sidebar="1"]
Attributes:
section – Filter to one source: base, addons, or an addon slug.
theme – light, dark, or auto (follows OS preference).
search – Set to 0 to disable the search box.
sidebar – Set to 0 to hide the left sidebar.
home – Slug of the default landing page.
WP-CLI
wp nvoos-docs rebuild # Chunked rebuild (default, runs across WP-Cron ticks)
wp nvoos-docs rebuild --sync # Inline rebuild in a single request (legacy)
wp nvoos-docs sync # Back-compat alias for --sync
wp nvoos-docs rebuild --resume # Resume a stalled or failed rebuild
wp nvoos-docs rebuild --cancel # Cancel an in-flight rebuild
wp nvoos-docs clear # Clear all cached data
wp nvoos-docs status # Show index statistics and rebuild phase
Source Code
The complete, human-readable source code for this plugin — including the
TypeScript/React source for the bundled assets/dist/docs-hub.js bundle — is
publicly available in the plugin’s GitHub repository:
https://github.com/nvdigitalsolutions/nvoos-docs-hub
The frontend bundle is generated from the src/ directory with esbuild:
npm install — installs the frontend dependencies (React, esbuild, etc.).
npm run build — runs node esbuild.config.js --prod and writes the
minified assets/dist/docs-hub.js and assets/dist/docs-hub.css.
The repository also contains the WordPress.org packaging and CI pipeline
(.github/workflows/, bin/), the PHPUnit test suite (tests/), and the
.wordpress-org/ listing assets.
Third-Party Libraries
The bundled assets/dist/docs-hub.js frontend is built from TypeScript/React
sources in the public repository and includes the following open-source
libraries (all GPL-compatible licenses; MIT unless noted):
React and React DOM (MIT) — https://react.dev
React Markdown (MIT) — https://github.com/remarkjs/react-markdown
React Router (MIT) — https://reactrouter.com
FlexSearch (Apache-2.0) — https://github.com/nextapps-de/flexsearch
Lowlight and highlight.js language grammars (MIT / BSD-3-Clause)
The unified/remark/rehype ecosystem: remark-gfm, remark-directive,
remark-frontmatter, rehype-slug, rehype-autolink-headings,
rehype-highlight, unist-util-visit (MIT) and github-slugger (ISC)
Build and test tooling (esbuild, ESLint, TypeScript, Vitest) is not shipped
in the distribution ZIP. The complete dependency graph and its licenses are
listed in package.json and package-lock.json in the public repository.
External Services
This plugin provides an optional documentation-import service, disabled
by default: remote requests happen only after an administrator enables
Remote Repositories in the settings, configures at least one repository,
and triggers a rebuild. When enabled, the plugin fetches Markdown files
from public GitHub repositories, stores them locally in the uploads cache,
and renders them in the documentation browser. Fetched content is cached
on your server, so visitors are served from the local cache, not from
GitHub.
All requests are made server-side only, over HTTPS, and only to the two
hosts listed below. Every request is restricted to these hosts (all other
hosts are rejected, including private and reserved IP addresses), carries a
bounded timeout and a 4 MB response-size cap, and only happens after an
administrator has enabled the Remote Repositories setting, configured a
repository, and a rebuild is triggered — manually, via WP-CLI, by the
nightly cron, or automatically when the cache is invalidated (a related
plugin is activated, deactivated, or updated).
No requests are made unless the Remote Repositories setting is enabled and
a repository is configured.
No account is required for public repositories. An optional GitHub
personal access token can be saved in the settings to raise GitHub’s API
rate limits; it is stored server-side and sent only to the two hosts below.
api.github.com — repository and tree metadata used by the file/folder
picker and the indexer.
raw.githubusercontent.com — raw Markdown file content fetched during
index rebuilds.
The plugin does not send any personal data to these services — it only
fetches the public repository content exactly as GitHub serves it. Rendered
documentation pages display the repository content as authored, which may
include links and images pointing at github.com,
raw.githubusercontent.com, or user-images.githubusercontent.com; those
are loaded by the visitor’s browser directly from the source repository,
not through the plugin or your server.
GitHub Terms of Service:
https://docs.github.com/en/site-policy/github-terms/github-terms-of-service
GitHub Privacy Statement:
https://docs.github.com/en/site-policy/privacy-policies/github-general-privacy-statement
This plugin also offers an optional, opt-in checkout for the NV oOS
Complete bundle — the full NV oOS plugin (base + Pro), which is a
separate plugin sold off-directory by NV Digital Unlocked LLC (the seller
of record, under license from NV Digital Solutions). The checkout opens
only when an administrator clicks “Get NV oOS Complete” on this
plugin’s own settings page; nothing runs in the background and the free
plugin is complete without it. No Stripe keys ship in this plugin — the
vendor’s own checkout server creates and verifies payments, and Stripe.js
is loaded from js.stripe.com only when the purchase modal opens.
All checkout requests are user-initiated, server-side only, over
HTTPS, and only to:
nvdigitalsolutions.com — the vendor checkout API
(/wp-json/nvoos-checkout/v1/): creates the Stripe payment session and
verifies the completed payment, issuing the license key and a signed,
expiring download URL. Sent: product name, site URL, Stripe payment
intent ID, buyer email, buyer country, Terms-consent timestamp.
js.stripe.com — Stripe’s payment form (loaded by the browser when the
modal opens). Card details are entered in Stripe’s own iframe; this
plugin never sees them.
github.com — only an HTTPS download of the purchased ZIP (a signed
vendor URL, or the public release asset fallback); no data sent.
Purchases require explicit agreement to the Terms of Service and Refund
Policy (consent timestamp recorded with the purchase) and a buyer email
address for the receipt. The Terms of Service and Refund Policy for the
vendor service are published at https://nvdigitalsolutions.com/terms-of-service
and https://nvdigitalsolutions.com/refund-policy.
