=== Easy Docs ===
Contributors: easyprolabs
Tags: docs, documentation, knowledge base, faq
Requires at least: 6.0
Tested up to: 7.0
Requires PHP: 7.4
Stable tag: 1.4.4
License: GPLv3 or later
License URI: http://www.gnu.org/licenses/gpl-3.0.html

Documentation plugin to quickly create pages, organize folders, import GitHub Markdown, and display docs with shortcodes.

== Description ==

Having a well-organized knowledge base is crucial for businesses and developers alike. It can reduce support tickets and streamline customer support by providing a well-structured knowledge base, allowing users to find answers quickly without contacting support.

Easy Docs is a powerful WordPress documentation plugin that simplifies the process of creating, managing, and displaying documentation. Whether you're building a knowledge base, user guide, or developer docs, Easy Docs streamlines content creation and enhances user experience.  

[youtube https://www.youtube.com/watch?v=ryHDrrj8Zuk]

Easy Docs is designed specifically for WordPress users, offering an intuitive way to create and manage documentation from a single admin page. Inspired by modern code editors, the backend provides a familiar, structured workspace for developers while ensuring a professional and user-friendly frontend presentation.

For teams that maintain documentation in GitHub, Easy Docs can link an outline folder to a public GitHub repository or folder URL and import Markdown files directly into WordPress. Linked folders can be synced again from the admin explorer, individual GitHub-backed documents can be refreshed on demand, and local edits can be protected by ignoring GitHub updates for selected documents.

**Key Features of Easy Docs**

- **Intuitive Interface**: The two-panel layout mirrors the modern code editor's interface, featuring a sidebar for organizing content into projects and subfolders, and a main editor for crafting your documentation with the rich TinyMCE text editor.

- **Project-Based Organization**: Each top-level folder represents a unique project, allowing users to efficiently manage multiple documentation sets within WordPress.

- **Efficient Document Management**: Easily create, edit, and manage documents with a dynamic tab-based system that enables quick navigation between multiple files.

- **Public GitHub Import and Sync**: Link an Easy Docs folder to a public GitHub repository or folder, import Markdown files as documentation pages, sync updates manually, and optionally remove synced docs when files are removed from GitHub.

- **Frontend Display Options**: Publish your documentation using a simple shortcode, which automatically generates a sidebar, dynamic content loading, and a search box for a seamless user experience.

**Efficiency and Ease of Use**

Easy Docs is built with usability in mind, making documentation creation faster and more efficient. Its user-friendly interface caters to both developers and non-technical users, ensuring that anyone can structure and maintain a knowledge base effortlessly.

**Enhancing the Frontend User Experience**

The frontend display of Easy Docs is designed for maximum readability and accessibility. It includes a built-in table of contents, instant search functionality, and a professional layout, allowing users to navigate documentation with ease.

**Perfect for Developers and Non-Developers Alike**

Whether you’re a developer managing technical documentation or a business owner creating a help center, Easy Docs offers the flexibility and efficiency you need. Its structured backend and clean frontend make it a versatile solution for any WordPress site.

**Get Started with Easy Docs Today**

Easy Docs is the ultimate tool for creating, organizing, and displaying documentation in WordPress. Download Easy Docs today and streamline your content management process!

== Installation ==

Installing “Easy Docs” can be done either by searching for “Easy Docs” via the “Plugins > Add New” screen in your WordPress dashboard, or by using the following steps:

1. Download the plugin via WordPress.org
1. Upload the ZIP file through the ‘Plugins > Add New > Upload’ in your WordPress dashboard
1. Activate the plugin through the ‘Plugins’ menu in WordPress

== External services ==

This plugin uses the YouTube Embed service to display embedded videos on your website.

- **Service**: YouTube Embed (provided by YouTube)
- **Purpose**: To embed YouTube videos into posts or pages using iframe markup.
- **Data sent**: The plugin sends the YouTube video ID (extracted from the embed shortcode) to construct the iframe embed URL. No personal user data is transmitted by this plugin.
- **Privacy**: The plugin uses the "youtube-nocookie.com" domain to enhance privacy. However, loading the iframe may result in YouTube collecting data about users based on their interaction with the embedded video.
- **Terms and Policies**:
  - [YouTube Terms of Service](https://www.youtube.com/t/terms)
  - [YouTube Privacy Policy](https://policies.google.com/privacy)

**Note**: Users should ensure they comply with local data protection laws regarding embedding third-party content.

This plugin can also connect to the GitHub API when an administrator links a public GitHub repository or folder for documentation import and sync.

- **Service**: GitHub API (provided by GitHub)
- **Purpose**: To read public repository metadata, folder trees, and Markdown file contents so public documentation can be imported and synced into Easy Docs.
- **Data sent**: The plugin sends the public repository owner, repository name, branch, folder path, and file blob identifiers required to fetch the selected Markdown files. No personal user data is sent by this plugin.
- **Privacy**: GitHub may collect request metadata according to its own policies. GitHub import and sync only runs when an administrator links or syncs a public GitHub repository or folder.
- **Terms and Policies**:
  - [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-privacy-statement)

== Frequently Asked Questions ==
= I have created the documentation. Now, how to display it? =
On admin page (where you have created the documentation), you should a see a shortcode on top right of the documentation window. Just copy and paste it in your widget, editor block or any page builder to display the documentation.

== Screenshots ==
1. Easy Docs backend screen to create documentation
2. Easy Docs frontend documentation display

== Changelog ==
= 1.4.4 =
* Add: Import Markdown documentation from public GitHub repositories and folders.
* Add: Sync linked GitHub folders and individual GitHub-backed documents from the admin explorer.
* Add: Option to ignore GitHub updates for selected documents and resume syncing later.
* Add: Optional cleanup for synced docs when files are removed from GitHub.
* Modify: Redesign player and frontend improvements.

= 1.4.2 =
* Modify: Frontend UX improvements.
* Modify: Backend UX improvements and multi outline item selection.

= 1.4.1 =
* Modify: Front and Backend design Improvements.

= 1.4.0 =
* Modify: In admin explorer, clicking outside the input will also create the outline or doc.
* Modify: Update readme documentation

= 1.2.0 =
* Add: Copy link button to copy link of the current document.
* Add: Cache documents in variable to prevent duplicate ajax requests.
* Modify: Styling Improvements.

= 1.1.0 =
* Modify: First official release to WordPress repository

= 1.0.3 =
* Error Fix: Primary review bug fixes.

= 1.0.2 =
* Modify: Removed unnecessary files.
* Modify: Update credit.txt to include font icons used.
* Modify: Security check and comments.
* Error Fix: Easy Docs Admin page explorer click error fix.

= 1.0.0 =
* First Release

== Upgrade Notice ==
