search

bhaumikmistry / open-connect-art

Open connect art is an art display created by the open source community
https://bhaumikmistry.github.io/open-connect-art/
MIT License
8 stars 44 forks source link

Issue 33: Add README.md file below the Tile grid on the web page #105

Open MeisterRed opened 4 years ago

MeisterRed commented 4 years ago

Hello, sorry for the very late response but I have come up with a solution for issue #33 . I was able to get the readme.md file to display under the art as you requested but I required a few additional libraries to help me out. To carry out with this request, I've used a node library known as Marked.

image

The markdown.js file will read the README.md file and then rewrite it into a HTML file. This HTML file will then be displayed as an object right underneath the art piece. If you make any changes to the README.md file, you'll need to go into the terminal, direct yourself to the js folder and run "node markdown.js" in order to update the README section of the HTML

image

I hope you are satisfied with how Implemented this display. If you need any clarification or want me to make any changes, I'll be happy to do so

welcome[bot] commented 4 years ago

Thanks so much for opening your first PR here!