paipaiio/readme.html

readme.html is a plugin for Codex, an AI coding assistant, that converts a project's README.md file into a richer, interactive HTML page. Rather than simply rendering Markdown as a flat webpage, it also scans the project's actual folder structure, reading entry files, configuration files, scripts, and deployment files, to supplement what the README says and flag discrepancies between the documentation and the real code. The resulting HTML page includes several interactive features: tabbed navigation that splits content into sections such as Overview, Installation, and Deployment, one-click copy buttons on commands and code snippets, a parameter preview panel where users can adjust settings and see how a command would change, and a search bar for quickly finding content. Sensitive information such as real API keys or database passwords is automatically stripped out. The page is fully self-contained, since all styling and scripts are embedded in the single HTML file, so it opens from a local folder without needing an internet connection. To install it, you clone the repository into Codex's skills directory, then ask Codex to run the conversion on your project. The result is a README.html file saved alongside the README.md. A GitHub Actions workflow can automatically publish the HTML file to GitHub Pages when you push changes. This would be useful to developers who want to share project documentation in a more readable, interactive format, for example when handing off a project, preparing for a demo, or publishing docs without setting up a dedicated documentation site. The project is released under the MIT license.