DEV Community

Clark Weckmann
Clark Weckmann

Posted on • Originally published at weckmann.me on

What is ReadMeJS?

ReadMeJS

Recently, I was working on a simple interface for markdown notes on Codepen. I wanted an easy way to show some documentation. Rather than finishing my project by just adding a paragraph or two, I built this.

Built with Bulma, Showdown, and Love

Bulma is responsible for the styling while Showdown converts your README markdown to HTML.

How to use it!

Add this <script> and <div> to your HTML.

<div id="readme"></div><script src="https://cdn.jsdelivr.net/gh/clarkhacks/readmejs/readme.min.js"></script>
Enter fullscreen mode Exit fullscreen mode

Configure ReadMeJS like so:

readme("clarkhacks", "readmejs");// readme(username, repository, filename);
Enter fullscreen mode Exit fullscreen mode

Demo

ReadMeJS layout demo


Reply via email

Discussion (1)

Collapse
wkmn profile image
Clark Weckmann Author