Changeset 3749914

Timestamp:

10/16/2026 08:05:10 AM (39 hours ago)

Author:

4ving

Message:

Update readme descriptions and FAQ

File:

• marktreedoc/trunk/readme.txt (modified) (2 diffs)

marktreedoc/trunk/readme.txt

@@ -1 +1 @@
 === MarkTreeDoc ===
 Contributors: 4ving
-Tags: documentation, markdown, docs, pure css, table of contents
+Tags: documentation, markdown, knowledge base, api documentation, docs
 Requires at least: 5.8
-Tested up to: 7.1
+Tested up to: 6.7
 Requires PHP: 7.4
 Stable tag: 1.0.0
@@ -9 +9 @@
 License URI: https://www.gnu.org/licenses/gpl-2.0.html
 
-Zero-JS, pure HTML5 and CSS3 modern three-column documentation generator for WordPress.
+Build professional, responsive API documentation and knowledge bases from Markdown. Embed anywhere with a single shortcode.
 
 == Description ==
 
-MarkTreeDoc is a modern, lightweight, high-performance documentation plugin for WordPress built with pure HTML5 and CSS3.
+**MarkTreeDoc** is a powerful, lightweight documentation plugin that transforms your Markdown files into modern, responsive, professional documentation and knowledge base pages in WordPress.
 
-It features zero client-side JavaScript for front-end rendering, providing blazing fast speed, complete SEO friendliness, tree navigation, one-page instant tab switching, syntax highlighting, breadcrumbs, right outline TOC, and more.
+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"]`.
 
-= Key Features =
+### Why MarkTreeDoc?
 
-* **Zero Client JS**: Pure HTML5 and modern CSS3 rendering without heavy frontend scripts.
-* **Three-Column Layout**: Left tree navigation, center content flow, and right outline/notes sidebar.
-* **Instant Tab Navigation**: Seamless single-page tab transitions driven by CSS pseudo-classes.
-* **Built-in Markdown Engine**: Full GFM support including tables, task lists, alerts, blockquotes, and footnotes.
-* **Syntax Highlighting**: Pre-rendered syntax highlighting for PHP, Python, JavaScript, CSS, HTML, Bash, Go, Rust, and more.
-* **Responsive Design**: Fluid mobile and desktop experiences with collapsible sidebars.
-* **Multilingual Ready**: Fully compatible with Polylang and Loco Translate, with built-in English and Simplified Chinese support.
+* **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.
 
 == Installation ==
 
-1. Upload the `marktreedoc` folder to the `/wp-content/plugins/` directory, or install the plugin directly through the WordPress plugins screen.
-2. Activate the plugin through the 'Plugins' screen in WordPress.
-3. Use the 'MarkTreeDoc' menu in the admin dashboard to create and manage your doc sets.
-4. Copy the shortcode `[marktreedoc id="X"]` and insert it into any post, page, or template.
+1. Upload the `marktreedoc` folder to `/wp-content/plugins/`, or install directly via the WordPress Plugins repository.
+2. Activate the plugin through the **Plugins** screen in WordPress.
+3. Go to the **MarkTreeDoc** menu in your WordPress admin dashboard to create and organize your documentation set.
+4. Copy the shortcode `[marktreedoc id="X"]` and paste it into any page, post, or template.
 
 == Frequently Asked Questions ==
 
-= Does MarkTreeDoc require frontend JavaScript? =
-No. The frontend document display is rendered using pure HTML5 and CSS3, requiring zero JavaScript on the client side.
+= 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 Polylang and Loco Translate? =
-Yes. MarkTreeDoc is fully localized and compatible with standard gettext translation tools like Loco Translate, as well as multi-language plugins like Polylang.
+= 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.
 
-== External Services ==
+= 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.
 
-MarkTreeDoc runs entirely on your local WordPress installation and does NOT connect to any external third-party services, remote APIs, or cloud analytics. All Markdown parsing, syntax highlighting, and HTML/CSS compilation are processed locally on your server.
+= 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.
 
 == Screenshots ==
 
-1. Pure HTML5 and CSS3 three-column documentation reader with instant tab switching.
-2. Visual tree structure designer and live markdown editing workspace in WordPress admin.
-3. Fluid responsive layout on mobile devices with collapsible navigation sidebar.
-4. Flexible layout options including breadcrumbs, outline TOC, and syntax highlighting.
+1. Modern three-column documentation reader with left tree navigation and right outline TOC.
+2. Admin document manager for organizing multi-level Markdown documentation sets.
+3. Fluid mobile drawer navigation with touch-friendly collapsible sidebar.
+4. Pre-rendered code syntax highlighting and breadcrumb navigation.
 
 == Changelog ==
 
 = 1.0.0 =
-* Initial public release with full Markdown parsing, tree navigation, and zero-JS frontend compiler.
-
+* Initial public release: Markdown parsing, tree navigation, multi-column layout, and one-click shortcode embedding.