Easy Docs

Beschrijving

Easy Docs is the ultimate WordPress plugin for creating comprehensive documentation with ease. Whether you’re building product guides, software manuals, or any other type of documentation, Easy Docs is designed to streamline the process for developers and non-developers alike.

Key Features:

  1. Familiar, Intuitive Interface
    Easy Docs brings a VS Code-inspired layout to WordPress, with a two-panel interface:

    • Explorer (Sidebar): Add folders (projects), subfolders, and documents to outline your documentation structure.
    • Editor (Main Content): Edit documentation with a rich TinyMCE text editor for individual documents.
  2. Project-Based Organization
    Each top-level folder represents a project. Create multiple projects, each with its unique set of folders and documents.

  3. Efficient Document Creation & Management

    • Add folders and documents dynamically without page reloads (via Ajax).
    • Open multiple documents simultaneously as tabs, making it easy to switch between topics.
  4. Frontend Documentation Display

    • Use a simple shortcode, e.g., [easydocs doc="A"], to display a project.
    • The frontend includes:
      • Sidebar: Mirrors your documentation structure.
      • Main Content Area: Dynamically loads document content via Ajax.
      • Table of Contents (ToC): Automatically generated from headings for quick navigation.
      • Search Box: Perform instant Ajax-powered searches across your documentation.
  5. Developer-Friendly Design
    Easy Docs keeps the workflow familiar for developers, with a backend designed for efficient documentation creation.

Benefits:

  • Save time with dynamic document management.
  • Create a professional, user-friendly frontend for your documentation.
  • Easily scale your documentation with unlimited projects, folders, and documents.

Easy Docs is perfect for anyone looking for a straightforward and powerful solution to build and display documentation 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:

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

Schermafdrukken

  • Easy Docs backend screen to create documentation
  • Easy Docs frontend documentation display

Installatie

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
  2. Upload the ZIP file through the ‘Plugins > Add New > Upload’ in your WordPress dashboard
  3. Activate the plugin through the ‘Plugins’ menu in WordPress

FAQ

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.

Beoordelingen

Er zijn geen beoordelingen voor deze plugin.

Bijdragers & ontwikkelaars

“Easy Docs” is open source software. De volgende personen hebben bijgedragen aan deze plugin.

Bijdragers

Vertaal “Easy Docs” naar jouw taal.

Interesse in ontwikkeling?

Bekijk de code, haal de SVN repository op, of abonneer je op het ontwikkellog via RSS.

Changelog

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