如何在HTML文件中包含markdown(.md)文件

蜗牛

假设我README.md在github存储库中有一个文件。然后,我将建立一个有关此存储库的所有网站,我将使用它们来托管gh-pages

我想要的是让index.html文件的一部分从文件中获取内容README.md这样,只需更新一个文件。

我认为markdown文件首先需要转换为html,然后可以将html放入另一个html文件中。

我已经研究了HTML5导入,但是Chrome目前仅支持它们。使用单独的.js文件document.write()可能很有用,但是有没有一种简单,干净的方法?

蜗牛

使用Node.js的完整答案

1.首先安装markedmarkdown转换器:

$ 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] 删除。

编辑于
0

我来说两句

0条评论
登录后参与评论

相关文章

来自分类Dev

在R Markdown文件中包含HTML文件?

来自分类Dev

使用jekyll时如何在markdown文件中包含“ {%%}”?

来自分类Dev

如何在rails中包含html文件?

来自分类Dev

如何在html中包含javascript文件?

来自分类Dev

如何在.ts文件中包含HTML

来自分类Dev

如何在rails中包含html文件?

来自分类Dev

如何在 HTML 中包含头文件

来自分类Dev

如何在 md 文件中编写原始 HTML 实体?

来自分类Dev

如何在包含json的html中包含.js文件?

来自分类Dev

我如何git diff markdown(.md)文件

来自分类Dev

如何在 Github 的 README.md 文件中冻结列/行 Markdown 表?

来自分类Dev

Github在README.md中包含md文件?

来自分类Dev

如何包含html中包含的html文件?

来自分类Dev

如何使Vim理解* .md文件包含Markdown代码,而不包含Modula-2代码?

来自分类Dev

什么是.md文件?

来自分类Dev

如何在Jekyll帖子中包含Rmarkdown / HTML文件

来自分类Dev

如何在HTML文件中包含npm包?

来自分类Dev

如何在html / javascript中包含位于projectfolder之外的文件

来自分类Dev

如何在Manifest.JSON中包含此HTML文件

来自分类Dev

如何在WampServer的HTML文件中包含PHP脚本?

来自分类Dev

Eclipse Markdown插件-双击.md文件时如何打开Markdown HTML预览?

来自分类Dev

如何从包含htmlwidget的rmarkdown文件生成md文件

来自分类Dev

如何在Windows下创建md文件

来自分类Dev

在 Azure Devops 的另一个 Readme.md 中包含 Markdown 文件

来自分类Dev

如何在Windows 7中打开'README.md'文件?

来自分类Dev

如何在另一个HTML文件中包含HTML文件

来自分类Dev

如何获得recoll包以索引markdown(.md)文件?

来自分类Dev

什么是history.md文件?

来自分类Dev

从.md或.json文件导入数据

Related 相关文章

热门标签

归档