在我的网站中可视化README.md文件

时间:2016-02-16 20:26:53

标签: html github markdown

我想在我的网站上的github项目中可视化README.md文件。 做这个的最好方式是什么?就像获取降价代码并在本地处理标记一样?或者有一种方法从github获取已处理的markdown?

3 个答案:

答案 0 :(得分:2)

一种可能的解决方案是使用基于javascript的降价解析器,例如https://github.com/evilstreak/markdown-js

可以从浏览器加载该库,并可以显示降价。在此示例中(取自上述网站),您需要在网站的输出中获取并插入降价:

<!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>

答案 1 :(得分:1)

在您的javascript上使用Github API - Markdown

答案 2 :(得分:1)

Here is a much better way to do it似乎更符合这些问题,并且确实满足了我的需求。 这实现了一个服务器端后端处理器,该服务器可以动态处理从Markdown渲染的HTML。

以下是PHP的摘录,但其他语言受支持并记录在链接中:

  

PHP

     
      
  1. 下载PHP Markdown(或PHP Markdown Extra)和
  2.   
  3. PHP SmartyPants   来自Michel Fortin。
  4.   
  5. 将markdown.php和smartypants.php放在   PHP的包含路径(或与render.php相同的目录)。

  6.   
  7. 在您的Apache配置中添加别名:

  8.   
     

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

     
      
  1. 添加重写规则。这个   可以在特定文件夹的.htaccess文件中完成,也可以在   全局Apache配置。包括一些常见的扩展名,但是您可以   根据您的需求进行调整。 (您可能希望将所有文本处理为   通过添加“ txt”来降价。)
  2.   
     

# 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]