如何从 Github Wiki Markdown 自动创建 HTML 文件?

问题描述 投票:0回答:1

对于即将在 Github 上发布的项目,我编写了一个内容广泛的 README.md 文件(即一个 Wiki Markdown 文件,该文件将被转换为 HTML 并显示在项目的主页上)。 现在,当从正在运行的应用程序中单击帮助按钮或链接时,我想显示与帮助相同的文本。

为此,我看到两个选择:

  1. 当点击“帮助”时,它会启动系统的默认浏览器并将其定向到项目的 Github 主页。
  2. “以某种方式”将 README.md 文件转换为 HTML 并将其与应用程序一起发布。然后使用应用程序中的某些 HTML 小部件显示该 HTML 文本,或者再次启动浏览器并从应用程序本地提供 HTML。

我不喜欢第一种方法的是,Github 页面还包含杂项。 Github 的项目相关内容(代码、存储库、问题、拉取请求等),即当页面显示为帮助文本时,大量与此处不相关的内容。

第二种方法对我来说听起来更简单更好,因为我的应用程序无论如何都是基于 Spring-boot 的,即当我将 HTML 文件放入应用程序的资源文件夹中时,内置的 HTTP 服务器可以轻松地为其提供服务。

因此我的问题是:在项目构建期间(我使用 Maven 作为构建工具),如何从 README.md 文件(Github Markdown 格式)生成并保存 HTML 文件? 我用谷歌搜索了一下,但发现没有支持该功能的工具或编辑器(如果它可以与构建过程集成,那就太好了,尽管这不是一个严格的要求 - 如果我偶尔不得不这样做,我不介意手动转换...)。

如果重要的话:markdown 文件还引用了杂项。图片(.png 文件)。这些还需要随应用程序一起提供,并且需要由生成的 HTML 文件引用。

github-flavored-markdown
1个回答
0
投票

我希望我没有误解这个问题,因为它的答案非常简单,但为什么不使用 MD 到 HTML 转换器呢?我最近正是使用这个来完成类似的事情。

https://codebeautify.org/html-to-markdown

如果这还不够,请说明原因

© www.soinside.com 2019 - 2024. All rights reserved.