假设我README.md
在github存储库中有一个文件。然后,我将建立一个有关此存储库的所有网站,我将使用它们来托管gh-pages
。
我想要的是让index.html
文件的一部分从文件中获取内容README.md
。这样,只需更新一个文件。
我认为markdown文件首先需要转换为html,然后可以将html放入另一个html文件中。
我已经研究了HTML5导入,但是Chrome目前仅支持它们。使用单独的.js
文件document.write()
可能很有用,但是有没有一种简单,干净的方法?
使用Node.js的完整答案
1.首先安装marked
markdown转换器:
$ npm install --save-dev marked
2.然后在一个名为的新文件中generateReadMe.js
,将markdown编译为HTML并将其写入新README.html
文件:
var marked = require('marked');
var fs = require('fs');
var readMe = fs.readFileSync('README.md', 'utf-8');
var markdownReadMe = marked(readMe);
fs.writeFileSync('./site/README.html', markdownReadMe);
3.然后index.html
在所需README.md
内容的内部添加一个<object>
标签:
<object data="README.html" type="text/html"></object>
4.然后在命令行上运行它以使其实现:
$ node path/to/generateReadMe.js
整个过程非常简单且轻松。我将整个内容添加到了npm start
脚本中。现在,无论README.md
何时我对文件进行更改,更改都将在我的gh-pages网站上注册。
本文收集自互联网,转载请注明来源。
如有侵权,请联系[email protected] 删除。
我来说两句