https://github.com/chrisbroski/index-readme

index.html page that automatically imports and displays the README.md in HTML.
https://github.com/chrisbroski/index-readme

Last synced: 8 days ago
JSON representation

index.html page that automatically imports and displays the README.md in HTML.

• Host: GitHub
• URL: https://github.com/chrisbroski/index-readme
• Owner: chrisbroski
• Created: 2015-03-12T16:38:00.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-06-06T14:37:52.000Z (over 9 years ago)
• Last Synced: 2024-05-07T18:10:21.868Z (9 months ago)
• Language: HTML
• Size: 285 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Index README

============

*Index README* is a stand alone HTML page that automatically imports a GitHub repository's README.md and displays it as web page. Just put a copy of the *index.html* page in the root directory of your GitHub repository, and when you deploy to [GitHub Pages](https://pages.github.com/), your README.md file will shown as the default web page.

*Index README* uses [Showdown.js](https://github.com/showdownjs/showdown) for markdown conversion (most recent version from 2015-01-03) [Simple.css](https://github.com/chrisbroski/simple-css) for basic page layout and a little extra CSS based on [Github style markdown](https://help.github.com/articles/github-flavored-markdown/) so styles are similar to how your GitHub README file is displayed from your repository.