Petra
AI assistant for GrootMade
Hi! I'm Petra 👋 Ask me to help you find the perfect WP plugin, theme, or template kit.
Display and embed readme files from local, SVN, or GitHub sources using shortcodes.
This plugin parses markdown readme files and makes their content available for display within your site using shortcodes. It is designed for developers and site administrators who need to present documentation, plugin details, or project information directly from a readme.txt or readme.md file. The tool fetches files from various sources and allows granular control over which parts are shown.
Flexible File Sources: Load readme files from your local server (within plugin, theme, or content directories), from the official SVN repository, or directly from a GitHub repository, including private repos with an access token.
Targeted Content Display: Use simple shortcodes to output the entire document, specific header values like 'Version' or 'Author', or individual sections such as 'Description' or 'Changelog'. This prevents the need to manually copy and update documentation.
Embedding and Caching: Paste a direct URL to a readme file into a post to embed it automatically. The plugin includes configurable caching to improve performance and reduce external API calls, with a default lifetime of one day.
Extended Format Support: Works with standard WordPress readme.txt format and supports common markdown (.md) files. It also handles non-standard extensions like contributor profile links and banner sections for greater flexibility.
Code Display: Can display entire code files as syntax-highlighted blocks within your content, specifying the language for proper formatting.