Skip to content Skip to sidebar Skip to footer
Home / Github / Html / Markdown

Visualizing Readme.md Files In My Website

Post a Comment
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 th

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><textareaid="text-input"oninput="this.editor.update()"rows="6"cols="60">Insert proxied **Markdown** here.</textarea><divid="preview"></div><scriptsrc="lib/markdown.js"></script><script>functionEditor(input, preview) {
        this.update = function () {
          preview.innerHTML = markdown.toHTML(input.value);
        };
        input.editor = this;
        this.update();
      }
      var $ = function (id) { returndocument.getElementById(id); };
      newEditor($("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

  1. 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).

  4. Add an alias in your Apache config:

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

  1. 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".)

# display Markdown as HTML by default RewriteEngine on RewriteRule .+\.(markdown|mdown|md|mkd)$ /markdown/render.php RewriteRule .+\.(markdown|mdown|md|mkd)\-text$ /markdown/render.php [L]

Solution 3:

https://github.com/zhlicen/md.htm An example of zeromd.js Just serve the md.htm file and md files, and visit directly by url: /md.htm?src=README.md

Or directly use my github page, Example: https://b.0-0.plus/blog/md.htm?src=https://raw.githubusercontent.com/microsoft/vscode/main/README.md

Post a Comment for "Visualizing Readme.md Files In My Website"