WP-Readme

WordPress plugin/theme readme file standard. Readme.txt

View the Project on GitHub

Index of pages:

https://pippinsplugins.com/how-to-properly-format-and-enhance-your-plugins-readme-txt-file-for-the-wordpress-org-repository/

https://make.wordpress.org/themes/2015/04/29/a-revised-readme/

https://wordpress.org/plugins/developers/#readme

https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/

https://www.drupal.org/docs/develop/documenting-your-project/readme-template

https://gist.github.com/PurpleBooth/109311bb0361f32d87a2

http://daringfireball.net/projects/markdown/syntax

https://software-development-guidelines.github.io/WP-Readme/

https://generatewp.com/plugin-readme/?clone=test-plugin-readme-txt-file

Summary

Readme files

To make your entry in the plugin browser most useful, each plugin should have a readme file named readme.txt that adheres to the WordPress plugin readme file standard. You can put your readme file through the readme validator to check it.

If you’d like to leave feedback, please open an issue on GitHub.

Introduction


Start page