外掛說明
MarkTreeDoc is a powerful, lightweight documentation plugin that transforms your Markdown files into modern, responsive, professional documentation and knowledge base pages in WordPress.
Whether you are building developer API references, SaaS technical guides, product manuals, or company knowledge bases, MarkTreeDoc allows you to embed a full-featured, multi-column documentation center into any page, post, or template using just a single shortcode: [marktreedoc id="X"].
Why MarkTreeDoc?
- Markdown-First Workflow: Write or import standard Markdown files (GFM). Instant parsing for tables, task lists, blockquotes, and code blocks.
- Embed Anywhere with One Shortcode: No need to rebuild your theme or set up subdomains. Insert
[marktreedoc id="X"]into any page, Elementor template, or block theme. - Professional Multi-Column Layout: Left-side tree navigation, centered readable document flow, and right-side interactive table of contents (TOC).
- Instant Tab Switching: Switch between documents without full-page reloads, providing a smooth single-page application (SPA) reading experience.
- Pre-rendered Code Syntax Highlighting: Clean, server-side syntax highlighting across all popular languages (PHP, JS, Python, Go, Bash, HTML, CSS, SQL, etc.) without heavy frontend bundle bloat.
- Flawless Mobile Experience: Fully responsive with touch-optimized collapsible drawer navigation and scroll-lock protection.
- Seamless Theme Compatibility: Smart sticky detector automatically adapts to your existing theme’s header and navigation bar without overlapping.
- SEO Friendly & Blazing Fast: Clean semantic HTML structure that search engine crawlers can index effortlessly.
螢幕擷圖
安裝方式
- Upload the
marktreedocfolder to/wp-content/plugins/, or install directly via the WordPress Plugins repository. - Activate the plugin through the Plugins screen in WordPress.
- Go to the MarkTreeDoc menu in your WordPress admin dashboard to create and organize your documentation set.
- Copy the shortcode
[marktreedoc id="X"]and paste it into any page, post, or template.
常見問題集
-
Can I embed documentation into my existing WordPress theme?
-
Yes! MarkTreeDoc is completely non-intrusive. It outputs inside standard WordPress content areas via shortcode and automatically adapts to your theme’s typography, container width, and fixed headers.
-
Does it support standard Markdown syntax?
-
Yes. MarkTreeDoc features a built-in GitHub Flavored Markdown (GFM) engine supporting headings, tables, task lists, code blocks, alerts, footnotes, blockquotes, and inline formatting.
-
Can I customize themes and colors?
-
Yes, MarkTreeDoc comes with modern light and dark themes (including Nord, Slate, Indigo, and GitHub styles) designed specifically for technical documentation.
-
Is it search engine (SEO) friendly?
-
Absolutely. Unlike client-heavy SPA frameworks that render via JavaScript, MarkTreeDoc pre-renders clean semantic HTML on the server, ensuring Google and other search engines index every section.
-
Does it require complicated server configurations or Node.js?
-
No. MarkTreeDoc runs 100% on native PHP and MySQL within standard WordPress hosting. No Node.js, static site generators, or external build steps are required.
使用者評論
這個外掛目前沒有任何使用者評論。
參與者及開發者
變更記錄
1.0.0
- Initial public release: Markdown parsing, tree navigation, multi-column layout, and one-click shortcode embedding.