Web Design

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

Awk Static Site Generators
UNKTiny static site generator that includes a markup language; Fits under 1,000 bytes
zodiacStatic website generator powered by sh and awk
RISSInsert GitHub README in a static site and apply transformations
boboMinimalist static site generator
TinyLightweight static site generator contained in a single POSIX shell script

Read our verdict in the software roundup.


Best Free and Open Source Software LinuxLinks helps you discover the best free and open source software for Linux. Explore our extensive collection of recommended applications, including alternatives to popular proprietary software.

We also publish software reviews, Linux tutorials, hardware reviews, free programming books and articles covering the wider open source community. Browse our Linux resources to discover more.

Know a useful free and open source Linux application we haven't covered? Suggest a program for inclusion.

Has your software been featured on LinuxLinks? Display one of our Featured on LinuxLinks badges on your website or GitHub README.
Subscribe

Please read our Comment Policy before commenting.

Notify of
guest
0 Comments
Oldest
Newest Most Voted