Visualizing README.md files in my website

html github markdown

21,355

Solution 1

One possible solution is to use a javascript-based markdown parser, such as https://github.com/evilstreak/markdown-js.

That library can be loaded from the browser and can display the markdown. In this example (taken from the aforementioned site), you would need to fetch and insert the markdown in the output of your site:

<!DOCTYPE html>
<html>
  <body>
    <textarea id="text-input" oninput="this.editor.update()"
              rows="6" cols="60">Insert proxied **Markdown** here.</textarea>
    <div id="preview"> </div>
    <script src="lib/markdown.js"></script>
    <script>
      function Editor(input, preview) {
        this.update = function () {
          preview.innerHTML = markdown.toHTML(input.value);
        };
        input.editor = this;
        this.update();
      }
      var $ = function (id) { return document.getElementById(id); };
      new Editor($("text-input"), $("preview"));
    </script>
  </body>
</html>

Solution 2

Here is a much better way to do it that seems to be more in line with the questions and it certainly suited my needs. This implements a server-side, back-end processor that servers up HTML rendered from Markdown on the fly.

Here is an excerpt for PHP, but other languages are supported and documented in the link:

PHP

Download PHP Markdown (or PHP Markdown Extra) and 2. PHP SmartyPants from Michel Fortin. 3. Put markdown.php and smartypants.php somewhere in PHP's include path (or in the same directory as render.php).

Add an alias in your Apache config:

Alias /markdown/ "/var/www/support/markdown/"

Add rewrite rules. This

can be done in the .htaccess file for a specific folder, or in the global Apache config. Some common extensions are included, but you can adjust them to your needs. (You might want to process all text as Markdown by adding "txt".)

Solution 3

Use Github API - Markdown on your javascript.

21,355

Author by

Daniel

Updated on March 10, 2022

Comments

Daniel about 2 years

I want to visualize README.md files from a project in github, in my website. What is the best way to do this? Like fetch the markdown code and process the mark down locally? Or there is a way to fetch the already processed markdown from github?
- sergioFC about 8 years
  
  Possible duplicate of Javascript to convert Markdown/Textile to HTML (and, ideally, back to Markdown/Textile)
- yourcomputergenius over 5 years
  
  One answer suggests using JavaScript, but that leaves out the whole idea of it being a backend server process which could be the most appropriate solution.
Rolv Apneseth about 3 years

Firefox is warning me of a security risk from that top link
yourcomputergenius about 3 years

Hmm, looks like the link is bad now... I’ll check the archive...
JM Lord over 2 years

FYI Markdown-js is no longer maintained. The github page redirects to other projects : Markdown-It, Showdown, Marked
yourcomputergenius about 2 years

Fixed the link—it’s on GitHub now.