Skip to content

ReadMeJS is an easy way to embed your project's README file into any website!

License

Notifications You must be signed in to change notification settings

clarkhacks/ReadMeJS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

Hi 👋, I'm ReadMeJS

The easiest way to embed your project's README anywhere!

Read the blog poster here!

  • 📝 One <script> and a <div> is all it takes!
  • ⚡ This is a fresh project, keep your eyes open for updates!
<div id="readme"></div>
<script src="https://cdn.jsdelivr.net/gh/clarkhacks/readmejs/readme.min.js"></script>
readme("clarkhacks", "readmejs");
// readme(username, repository, filename);

The filename attribute defualts to README.md, if you use any other file name, this is where to specify it.

Built on Bulma and Showdown!

Bulma CSS is reposible for the styling and Showdown converts the markdown to html.

About

ReadMeJS is an easy way to embed your project's README file into any website!

Resources

License

Stars

Watchers

Forks

Packages

No packages published