README.txt with README.md

Created on 11 November 2022, over 2 years ago
Updated 1 May 2024, 10 months ago

We could be using README.md instead of README.txt to make use of the nicer rendering via markdown.

Now that we've moved to GitLab, we should probably use Markdown instead of plain .txt files for our documentation

๐Ÿ“Œ Task
Status

Fixed

Version

1.0

Component

Documentation

Created by

๐Ÿ‡ฎ๐Ÿ‡ณIndia Naveen Kumar Reddy

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • Merge request !1Update README.md โ†’ (Merged) created by Naveen Kumar Reddy
  • Status changed to Needs review almost 2 years ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Manoj Raj.R Chennai

    Updated with the latest Readme format as Drupal recommended.

    https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or... โ†’

    Please review.

  • Status changed to RTBC almost 2 years ago
  • ๐Ÿ‡ฎ๐Ÿ‡ณIndia Bushra Shaikh

    I have successfully reviewed your merge request !1 for Drupal version 10.0.2.
    README.txt file was updated to README.md after applying this patch.
    Adding screenshots for reference.

    Can be moved to RTBC +1

  • ๐Ÿ‡ฟ๐Ÿ‡ฆSouth Africa alabandit

    I have extended the README.md work above and added a section to clarify the configuration.

    Sorry, that I haven't rolled a patch, but here is the edit below.

    I have extended the README.md work above and added a section to clarify the configuration.  
    
    # CKEditor Accordions - Detail Plugin
    
    Accordions are a popular way to structure content. In the past nested divs or definition lists were augmented by Javascript to provide this functionality, but the HTML5 details elements provide this functionality natively. This module adds a button so editors can easily use this element in their content.  
    
    For a full description of the module, visit the 
    [project page](https://www.drupal.org/project/ckeditor_details).
    
    # Table of contents
    
    - Requirements
    - Recommended modules
    - Installation
    - Configuration
    - Troubleshooting
    - FAQ
    - Maintainers
    
    # Requirements
    This module requires the core CKEditor module.
    
    # Recommended modules
    
    
    # Installation
    
    1. Download the plugin from [ckeditor](http://ckeditor.com/addon/detail)
    2. Place the plugin in the root libraries folder (`/libraries`).
    3. Enable CKEditor Accordions - Detail Plugin module in the Drupal admin.
    
    Each filter format will now have a config tab for this plugin.
    
    
    # Configuration
    
    1. Go to the Text Formats and Editors settings  
    `Administration ยป Configuration ยป Content Authoring ยป Text formats`  
    (/admin/config/content/formats)  
    2. Edit a text format, for example, "Basic HTML"
    3. Then drag the Button to the CKEditor toolbar  
    The button icon is a square with a down arrow, as is often seen for drop-down menus. 
    
    
    
    
    # Troubleshooting
    
    Submit bug reports and feature suggestions or track changes in the 
    [issue queue](https://www.drupal.org/project/issues/ckeditor_details).
    
    
    # FAQ
    
    Please ask questions on the official project page [issue queue](https://www.drupal.org/project/issues/ckeditor_details).
    
    
    ## Uninstallation
    
    Uninstall the module in the standard way from the uninstall menu.  `Administer >> Modules >> Uninstall Modules`  
    /admin/modules/uninstall  
    
    ## Maintainers  
    
    * Martin Anderson-Clutz - [mandclu](https://www.drupal.org/u/mandclu)  
    * Initial development and maintenance by **Digital Echdina**.  
    
  • Pipeline finished with Skipped
    11 months ago
    #148977
  • First commit to issue fork.
  • Status changed to Fixed 11 months ago
  • ๐Ÿ‡จ๐Ÿ‡ฆCanada mandclu

    Thanks for everyone's work on this. This has been merged in.

  • Automatically closed - issue fixed for 2 weeks with no activity.

Production build 0.71.5 2024