RISS – insert GitHub README

RISS is an acronym for “README In Static Site”.

It is a script which lets you to insert your GitHub README in your static site and apply transformations. The transformations are driven by HTML comments, so that you can have different results when comments are ignored (e.g. in your GitHub README) and after executing the script on your Markdown file.

This script is free and open source software.

Key Features

• Offers more control on the theme and layout.
• Insert scripts that GitHub do not allow (such as asciinema scripts). You can’t embed the asciinema player on GitHub for security reasons.
• Offers the option of having your project’s home page independent of your hosting platform.

Website: github.com/cljoly/readme-in-static-site
Support:
Developer: Clément Joly
License: Apache License 2.0

RISS is written in Awk. Learn Awk with our recommended free books and free tutorials.

Related Software

Read our verdict in the software roundup.

Explore our carefully curated directory of recommended free and open source software, covering every major software category. The directory forms part of our extensive collection of articles for Linux enthusiasts. It includes hundreds of detailed reviews, together with free and open source alternatives to proprietary software from companies such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk. LinuxLinks also covers interesting projects worth exploring, Linux-compatible hardware, free programming books and tutorials, and much more. Know a useful free and open source Linux application that we haven’t covered? Tell us about it using our submission form.