Skip to content

63444 | Add a Markdown version of the README to ensure proper rendering in GitHub interface. #8802

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from

Conversation

KerubinDev
Copy link

Add README.md for proper GitHub rendering of WordPress repository

Add a Markdown version of the README to ensure proper rendering in the main WordPress GitHub repository (https://github.com/WordPress/WordPress).

The current README.html file in the main WordPress repository (https://github.com/WordPress/WordPress) displays as raw HTML code when viewed on GitHub, affecting readability and accessibility of WordPress documentation for developers. This PR adds a README.md file in Markdown format while maintaining the original README.html for backward compatibility.

Changes:

  • Convert HTML content to equivalent Markdown formatting
  • Preserve all links, structure, and information from the original
  • Maintain backward compatibility by keeping README.html

This improvement helps developers browsing the repository on GitHub to read the documentation more easily without having to download or view the raw HTML file.

Tested on Chrome, Firefox, and OperaGX browsers.

Props KerubinDev.
Fixes https://core.trac.wordpress.org/ticket/63444
README.MD

Copy link

Hi @KerubinDev! 👋

Thank you for your contribution to WordPress! 💖

It looks like this is your first pull request to wordpress-develop. Here are a few things to be aware of that may help you out!

No one monitors this repository for new pull requests. Pull requests must be attached to a Trac ticket to be considered for inclusion in WordPress Core. To attach a pull request to a Trac ticket, please include the ticket's full URL in your pull request description.

Pull requests are never merged on GitHub. The WordPress codebase continues to be managed through the SVN repository that this GitHub repository mirrors. Please feel free to open pull requests to work on any contribution you are making.

More information about how GitHub pull requests can be used to contribute to WordPress can be found in the Core Handbook.

Please include automated tests. Including tests in your pull request is one way to help your patch be considered faster. To learn about WordPress' test suites, visit the Automated Testing page in the handbook.

If you have not had a chance, please review the Contribute with Code page in the WordPress Core Handbook.

The Developer Hub also documents the various coding standards that are followed:

Thank you,
The WordPress Project

Copy link

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props kerubindev.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@KerubinDev KerubinDev changed the title Create issue file 63444 | Add a Markdown version of the README to ensure proper rendering in GitHub interface. May 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant