https://github.com/tamdilip/readme-renderer

A minimal fun app to render git repositories Readme.md file contents as a standalone webpage apart from gh-pages support.
https://github.com/tamdilip/readme-renderer

github-api github-markdown readme readme-reader

Last synced: 10 months ago
JSON representation

A minimal fun app to render git repositories Readme.md file contents as a standalone webpage apart from gh-pages support.

• Host: GitHub
• URL: https://github.com/tamdilip/readme-renderer
• Owner: tamdilip
• Created: 2020-04-29T15:55:30.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-13T15:52:02.000Z (about 3 years ago)
• Last Synced: 2025-02-12T10:43:39.207Z (12 months ago)
• Topics: github-api, github-markdown, readme, readme-reader
• Language: CSS
• Homepage: https://tamdilip.github.io/readme-renderer/
• Size: 4.31 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# 🖨️ readme-renderer

[![Live demo](https://img.shields.io/badge/gh%20pages-Live%20demo-blue?style=flat-square&logo=git&logoColor=violet)](https://tamdilip.github.io/readme-renderer)

A minimal app to render git repositories `Readme.md` file contents as a standalone webpage. Apart from the default gh-pages support to render Readme content, for cases when you have hosted an actual content in your repo and still wants to render and publish Readme as a separate page😉. 

## Usage

### 🏃🏼 way one:

- Go to [Readme-renderer](https://tamdilip.github.io/readme-renderer/) and enter your repo URL.

### 🏃🏼 way two:

- Go to your repo and prepend this app URL (retain `#` at the end)-  https://tamdilip.github.io/readme-renderer/# 

### 📽 Demo:

![demo](https://github.com/tamdilip/readme-renderer/blob/master/demo/demo.gif?raw=true)

**Happy coding :) !!**