README to index.html

Version updated for https://github.com/davorg/readme-to-index to version v1.0.3.

  • This action is used across all versions by ? repositories.

Action Type

This is a Composite action.

Go to the GitHub Marketplace to find the latest changes.

Action Summary

The readme-to-index GitHub Action automates the conversion of a README.md file into a clean, minimal index.html static website using Pandoc and Simple.css, while leaving the original Markdown file unchanged. It simplifies the process by eliminating the need for complex setups like Jekyll or additional configuration files, making it ideal for small projects or CI pipelines. Key features include automatic title generation from the first heading, classless styling, and straightforward integration into build workflows.

Release notes

Allow Pandoc installation when running in an environment that doesn’t include sudo.