GrootMade is NOT affiliated with {eac}Readme or its original author. {eac}Readme™ is a trademark of its respective owner and use of it does not imply any endorsement or affiliation. This product has been forked under the GNU General Public License (GPL) and all non-GPL assets (such as proprietary images, fonts, and branding) have been removed. Distributing GPL-licensed code is 100% legal.
This plugin loads and translates markdown readme files, allowing users to display content from those files within posts or pages using shortcodes. It is designed for developers and site administrators who need to showcase documentation, such as plugin or theme details, directly on their sites without manual formatting. The tool parses standard readme formats and offers flexible access to various parts of the file.
Shortcode Access: Use shortcodes to retrieve specific headers, sections, or the entire document from a readme file, with support for local paths, SVN, and GitHub sources.
Embedding URLs: Embed readme content by pasting URLs into posts or pages, with automatic formatting for files from your site, WordPress repositories, or GitHub.
Customization Options: Adjust cache settings, translation of header names, and code highlighting languages to tailor output to your needs.
Extended Format Support: Handles both traditional readme.txt and markdown .md files, including non-standard elements like banners and custom contributor formats.
Integration: Works with third-party tools through actions and filters, enabling external applications to use the parser class for advanced functionality.
We do not provide support for the original product. If you need official support, please purchase a license from the original developer. Our community assistance is only for issues related to our forked version.
Have questions, feedback, or need support? Join the discussion on our forum.
Discuss on ForumVersion
Author
Updated
Version
Author
Updated
Version
Author
Updated
Author
Version
Type
License
Access
Minimum Version
Requires PHP
Fork date
Updated
Original slug