Readme Extension\n<\/p>","2":"
Readme Help\n<\/p>"},"jetpack_post_was_ever_published":false},"plugin_section":[],"plugin_tags":[12156,212626,4608,42183,13433],"plugin_category":[],"plugin_contributors":[211905],"plugin_business_model":[],"class_list":["post-160547","plugin","type-plugin","status-publish","hentry","plugin_tags-code-highlighting","plugin_tags-eacdoojigger","plugin_tags-markdown","plugin_tags-parsedown","plugin_tags-readme","plugin_contributors-kevinburkholder","plugin_committers-kevinburkholder"],"banners":{"banner":"https:\/\/ps.w.org\/eacreadme\/assets\/banner-772x250.jpg?rev=2761820","banner_2x":"https:\/\/ps.w.org\/eacreadme\/assets\/banner-1544x500.jpg?rev=2761820","banner_rtl":false,"banner_2x_rtl":false},"icons":{"svg":false,"icon":"https:\/\/ps.w.org\/eacreadme\/assets\/icon-128x128.png?rev=2761820","icon_2x":"https:\/\/ps.w.org\/eacreadme\/assets\/icon-256x256.png?rev=2761820","generated":false},"screenshots":[{"src":"https:\/\/ps.w.org\/eacreadme\/assets\/screenshot-1.png?rev=3092459","caption":"
Readme Extension\n<\/p>"},{"src":"https:\/\/ps.w.org\/eacreadme\/assets\/screenshot-2.png?rev=3092459","caption":"
Readme Help\n<\/p>"}],"raw_content":"\n
{eac}Readme<\/em> is an {eac}Doojigger<\/a> extension which loads and translates a WordPress markdown 'readme' file providing shortcodes and embedding URLs to access header lines and section blocks.<\/p>\n\n The first used shortcode must indicate the file to load...<\/p>\n\n After which, headers and sections may be pulled from that file...<\/p>\n\n One shortcode can do it all...<\/p>\n\n Or load the entire file as a single code block...<\/p>\n\n Get header values...<\/p>\n\n Get unnamed segments...<\/p>\n\n Get section blocks...<\/p>\n\n Get multiple blocks and\/or sub-sections...<\/p>\n\n Get a file as a code block...<\/p>\n\n Change the default cache time-to-live by adding to wp-config.php:<\/p>\n\n Override the default cache time-to-live<\/p>\n\n Set the default GitHub access token (for private repositories):<\/p>\n\n Set\/override the GitHub access token<\/p>\n\n Override option to parse markdown when retrieving a segment<\/p>\n\n Set class='language-*' on code blocks<\/p>\n\n Translate header\/section names when retrieving All Headers<\/em>, All Sections<\/em>, or Document<\/em><\/p>\n\n Erase default translation table<\/p>\n\n Default translation table<\/p>\n\n {eac}Readme can also be used to embed URLs in a WordPress Post or Page. Simply paste the url in the <\/p>\n\n The shortcut to this is to simply paste the URL at the end of the page\/post where it says \"Type \/ to choose a block\". WordPress will automatically convert your URL to an embed block.<\/p>\n\n Files can be embedded from your site, from the WordPress repository or from Github. Embedded URLs are transformed internally to the appropriate format.<\/p>\n\n From your site<\/em><\/p>\n\n From the Wordpress Repository<\/em><\/p>\n\n From a GitHub Repository<\/em><\/p>\n\n To load only specific sections of the readme file, append a fragment to the url:<\/em><\/p>\n\n {eac}Readme expects a well-formed readme.txt file that follows the WordPress readme file standard<\/a>...<\/p>\n\n ...but supports some extensions to that standard:<\/p>\n\n Author & Author URI<\/p>\n\n Homepage<\/p>\n\n Version<\/p>\n\n Contributors<\/p>\n\n A \"banner\" section may be included between the top title line and the first header line.<\/p>\n\n The header block may be enclosed in an html Note: these extensions are not supported by the WordPress Plugin Repository.<\/p>\n<\/blockquote>\n\n {eac}Readme supports standard markdown (readme.md) formatting for section identification.\n+ When retrieving the header block with ...<\/p>\n\n Or when retrieving all sections with ...<\/p>\n\n Or when retrieving the entire document with ...<\/p>\n\n Additional html tags and classes are added, including wrapping blocks within a 3rd-party actors may load and use the parser class included in {eac}Readme...<\/p>\n\n {eac}Readme uses Prism syntax highlighter<\/a>, Copyright (c) 2012 Lea Verou<\/p><\/li>\n The {eac}SoftwareRegistry Software Product Taxonomy<\/a> plugin uses {eac}Readme to parse readme markdown files hosted on Github to provide plugin information and automated updates to WordPress for self-hosted plugins.<\/p><\/li>\n<\/ul>\n\n This program is free software: you can redistribute it and\/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.<\/p>\n\n This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.<\/p>\n\n You should receive a copy of the GNU General Public License along with this program. If not, see https:\/\/www.gnu.org\/licenses\/<\/a>.<\/p>\n\n\n {eac}Doojigger Readme Extension<\/strong> is an extension plugin to and requires installation and registration of {eac}Doojigger<\/a>.<\/p>\n\n This plugin is available from the WordPress Plugin Repository<\/a> and can be installed from the WordPress Dashboard \u00bb Plugins<\/em> \u00bb Add New<\/em> page. Search for 'EarthAsylum', click the plugin's [Install] button and, once installed, click [Activate].<\/p>\n\n See Managing Plugins -> Automatic Plugin Installation<\/a><\/p>\n\n Installation of this plugin can be managed from the WordPress Dashboard \u00bb Plugins<\/em> \u00bb Add New<\/em> page. Click the [Upload Plugin] button, then select the eacreadme.zip file from your computer.<\/p>\n\nShortcode Usage<\/h4>\n\n
[eacReadme file='\/docfolder\/readme.txt'] # file is relative to the WordPress document root folder\n[eacReadme content='\/contentfolder\/readme.txt'] # content file is relative to the WordPress content folder (wp-content\/)\n[eacReadme plugin='\/pluginfolder\/readme.txt'] # plugin file is relative to the WordPress plugins folder (wp-content\/plugins\/)\n[eacReadme theme='\/themefolder\/readme.txt'] # theme file is relative to the WordPress themes folder (wp-content\/themes\/)\n[eacReadme wpsvn='\/slugname\/trunk\/readme.txt'] # load file from WordPress SVN repository\n[eacReadme github='\/owner\/repository\/main\/readme.txt'] # load file from a github repository\n<\/code><\/pre>\n\n[eacReadme]All Headers[\/eacReadme] # parses all header lines\n[eacReadme]headerName[\/eacReadme] # gets the value of the named header line\n\n[eacReadme]All Sections[\/eacReadme] # parses all section blocks\n[eacReadme]sectionName[\/eacReadme] # parses the content of the named section block\n[eacReadme]sectionName\/sub-section[\/eacReadme] # parses the content of the named sub-section within section block\n<\/code><\/pre>\n\n[eacReadme plugin='\/pluginfolder\/readme.txt']Document[\/eacReadme] # loads the file and parses the entire document\n<\/code><\/pre>\n\n[eacReadme theme='\/themefolder\/functions.php']Code File[\/eacReadme]\n<\/code><\/pre>\n\nShortcode Examples<\/h4>\n\n
[eacReadme]Contributors[\/eacReadme]\n[eacReadme]Donate link[\/eacReadme]\n[eacReadme]Requires at least[\/eacReadme]\n[eacReadme]Stable tag[\/eacReadme]\n<\/code><\/pre>\n\n[eacReadme]Title[\/eacReadme] # gets the '=== plugin name ===' line (before headers)\n[eacReadme]Short Description[\/eacReadme] # gets the short description (between headers and first section block)\n<\/code><\/pre>\n\n[eacReadme]Description[\/eacReadme]\n[eacReadme]Installation[\/eacReadme]\n[eacReadme]Screenshots[\/eacReadme]\n[eacReadme]Changelog[\/eacReadme]\n<\/code><\/pre>\n\n[eacReadme plugin='\/eacReadme\/readme.txt']Short Description,Description[\/eacReadme]\n[eacReadme plugin='\/eacReadme\/readme.txt']Short Description,Description\/Shortcode Examples[\/eacReadme]\n<\/code><\/pre>\n\n[eacReadme theme='\/my-child-theme\/functions.js' lang='js']Code File[\/eacReadme]\n[eacReadme theme='\/my-child-theme\/style.css' lang='css']Code File[\/eacReadme]\n<\/code><\/pre>\n\nOther Options<\/h4>\n\n
define('EAC_README_CACHE_LIFETIME',$seconds); # default: 1-day (DAY_IN_SECONDS).\n<\/code><\/pre>\n\n[eacReadme ttl=$seconds ...] # minimum: 1-minute (MINUTE_IN_SECONDS).\n<\/code><\/pre>\n\ndefine('GITHUB_ACCESS_TOKEN',$token);\n<\/code><\/pre>\n\n[eacReadme token=$token ...]\n<\/code><\/pre>\n\n[eacReadme parse='true|false' ...]\n<\/code><\/pre>\n\n[eacReadme lang='php|js|css|html' ...]\n<\/code><\/pre>\n\nTranslating Header\/Section Names<\/h4>\n\n
[eacReadme translate='name=newname,...']\n[eacReadme translate='Requires at least=Requires WordPress Version,Screenshots=Screen Shots']\n<\/code><\/pre>\n\n[eacReadme translate='no|none|false']\n<\/code><\/pre>\n\n[\n 'Headers' => 'Document Header',\n 'Plugin URI' => 'Homepage',\n 'Stable tag' => 'Current Version',\n 'Requires at least' => 'Requires WordPress Version',\n 'Tested up to' => 'Compatible up to',\n 'Requires PHP' => 'Requires PHP Version',\n 'WC requires at least' => 'Requires WooCommerce',\n 'Requires EAC' => 'Requires {eac}Doojigger',\n 'Changelog' => 'Change Log',\n 'Screenshots' => 'Screen Shots',\n];\n<\/code><\/pre>\n\nEmbedding<\/h4>\n\n
Embed<\/code> URL block.<\/p>\n\n\n
https:\/\/<your_site_url>\/plugins\/<plugin_slug>\/readme.txt\nhttps:\/\/<your_site_url>\/themes\/<theme_name>\/readme.txt\n<\/code><\/pre>\n\nhttps:\/\/ps.w.org\/<plugin_slug>\/readme.txt\nhttps:\/\/plugins.svn.wordpress.org\/<plugin_slug>\/readme.txt\n<\/code><\/pre>\n\nhttps:\/\/github.com\/<owner>\/<repository>\/blob\/main\/readme.md\nhttps:\/\/github.com\/<owner>\/<repository>\/main\/readme.md\n<\/code><\/pre>\n\nhttps:\/\/<your_site_url>\/plugins\/<plugin_slug>\/readme.txt#allheaders\nhttps:\/\/ps.w.org\/<plugin_slug>\/readme.txt#description\nhttps:\/\/github.com\/<owner>\/<repository>\/main\/readme.md#screenshots\n<\/code><\/pre>\n\nReadme Format<\/h4>\n\n
title<\/h3>\n\n
header: value\nheader: value\nshort Description<h3>section<\/h3> = sub-section =\n<\/code><\/pre>\n\n\n
\n
Author<\/code> header may be a simple name or a markdown link:\n\n\n
[Author](Author URI)<\/code>.<\/li>\n<\/ul><\/li>\nAuthor<\/code> & Author URI<\/code> headers, if present, are combined as a markdown [Author](Author URI)<\/code>.<\/li>\n<\/ul><\/li>\n\n
Homepage<\/code> or Plugin URI<\/code>.<\/li>\n<\/ul><\/li>\n\n
Version<\/code> or Stable tag<\/code>.<\/li>\n<\/ul><\/li>\n\n
profileId<\/code> - wordpress profile (standard)<\/li>\nprofileId@youremaildomain.com<\/code> - gravatar profile<\/li>\nprofileId@wordpress<\/code> - wordpress profile<\/li>\nprofileId@gravatar<\/code> - gravatar profile<\/li>\nprofileId@github<\/code> - github profile<\/li>\n[display name](mailto:email@address.com)<\/code> or [display name](http:\/\/www.gravatar.com\/profileId\/)<\/code><\/li>\n[display name](http:\/\/profiles.wordpress.org\/profileId\/)<\/code><\/li>\n[your name]((http:\/\/your\/profile\/url)<\/code><\/li>\n<\/ul><\/li>\n<h3>title<\/h3> [](\/\/link_url)\nheader: value\nheader: value\nshort Description<h3>section<\/h3> = sub-section =<\/code><\/p><\/li>\n<header><\/code> or <details><\/code> tag, opening and closing each on a single line. These tags are ignored by the eacParseReadme parser but may be beneficial if posting your readme file elseware. See {eac}Readme on Github<\/a>.<\/p><\/li>\n<\/ul>\n\n\n
=== title ===<\/code> and ## title<\/code> are equivalent\n+ == section ==<\/code> and ### section<\/code> are equivalent\n+ = sub-section =<\/code> and #### sub-section<\/code> are equivalent<\/p>\n\nOutput HTML<\/h4>\n\n
[eacReadme]All Headers[\/eacReadme] or `\\eacParseReadme::getAllHeaders()`\n<\/code><\/pre>\n\n[eacReadme]All Sections[\/eacReadme] or `\\eacParseReadme::getAllSections()`\n<\/code><\/pre>\n\n[eacReadme]Document[\/eacReadme] or `\\eacParseReadme::getDocument()`\n<\/code><\/pre>\n\n<details><\/code> tags, adding readme-*<\/code> class names, and adding <a><\/code> anchor links.<\/p>\n\nWordPress Actions<\/h4>\n\n
do_action('eacReadme_load_parser'); \/\/ loads \\eacParseReadme static class\n if (class_exists('\\eacParseReadme'))\n {\n \\eacParseReadme::loadFile($readme,$context);\n $html_document = \\eacParseReadme::getDocument();\n $title = \\eacParseReadme::getTitle();\n $version = \\eacParseReadme::getVersion();\n $donations = \\eacParseReadme::getHeader('donate_link');\n $description = \\eacParseReadme::getSection('description');\n }= Additional Information =\n<\/code><\/pre>\n\n\n
Copyright<\/h3>\n\n
Copyright \u00a9 2019-2025, EarthAsylum Consulting, distributed under the terms of the GNU GPL.<\/h4>\n\n
Automatic Plugin Installation<\/h4>\n\n
Upload via WordPress Dashboard<\/h4>\n\n