691
Free
Add to project

Product support

Get help in the plugin support forum.

Categories

Note: This plugin is experimental and currently in beta status. "Beta" simply means that it is still in a development phase, it is only public for reasons of testing.

This plugin generates a README.md for plugins based on their code. The README.md file in the root of a plugin is available from the backend of any installation (by clicking on it from Settings -> System -> Updates & Plugins) and functions as a manual for your users. You can also use it as the basis for your online plugin documentation on the Marketplace.

Features

STATUS FEATURE
YES MULTILINGUAL
YES WILL NEVER OVERWRITE AN EXISTING README.MD
YES CUSTOM TEMPLATE FOR README.MD

Support

Please use the Support Forum (on the left side of the page for any theme or plugin) or send me a message. I also offer design and development services. You can visit my website for more information. Do not use reviews to ask for support.

Like this plugin?

Did you know that only about 30% of my plugins are paid (70% of my plugins are free) and that 30% of your purchase goes to help fund the October Project? If you purchase this plugin, you can help me to develop it further, provide support for it or make new plugins.

My other plugins include:

Hello, I am Wiego. Please start by reading the whole documentation! If you have any questions, find a bug or experience difficulties getting the plugin to work please use the Support Forum. Only leave a Review if you are happy with the plugin or are still unhappy with the plugin after reaching out to me in the Support Forum. Thank you! Wiego

Table of contents

Note: This plugin is experimental and currently in beta status. "Beta" simply means that it is still in a development phase, it is only public for reasons of testing.

Installation

  • To install from the Marketplace, click on the "Add to Project" button and then select the project you wish to add it to before updating the project in the backend of your website to pull in the plugin. To install from the backend, go to Settings -> Updates & Plugins -> Install Plugins and then search for Briddle.Doc.

Getting started

  1. Download Briddle.Doc.
  2. Go to Settings -> Doc in the backend to use the plugin.

The plugin creates a README.md file for any selected plugins that do not have one. You can copy the contents of README.md to use for the documentation on the October Marketplace as well. The plugin will never overwrite an existing README.md file.

#{{ plugin_name }}

{{ plugin_desc }}

##Components

The following components are available:

{% for key,value in plugin_components %}
- {{ key }}
{% endfor %}

##Widgets

The following widgets are available:

{% for key,value in plugin_widgets %}
- {{ key }}
{% endfor %}

##Available permissions

The following permissions are available:

{% for key,value in plugin_permissions %}
- {{ key }}
{% endfor %}

Available languages

This plugin can be translated in any language

This plugin supports the following languages out of the box:

  • english

Extending functionality

Customize template

You need to supply the template code for the README.md file in Settings -> System -> Doc. This template supports the following Twig placeholders:

  • plugin_name (string)
  • plugin_desc (string)
  • plugin_components (array)
  • plugin_widgets (array)
  • plugin_permisions (array)

Support

Please use the Support Forum (on the left side of the page for any theme or plugin) or send me a message. I also offer design and development services. You can visit my website for more information. Do not use reviews to ask for support.

1.0.2

Bugfixes.

Jul 21, 2020
1.0.1

Initialize plugin.

Jul 20, 2020