如何在Github存储库中读取.yaml文件并将内容发布到Github页面

时间:2019-02-06 15:20:57

标签: javascript github yaml github-pages github-api

我正试图从我的企业专用存储库中建立一个Github页面。存在一个yaml文件,其中包含存储库中应用程序列表的元数据,包括应用程序名称,描述和其他信息。我只想将名称和描述发布到Github页面,以后再创建一个搜索栏以在存储库中找到可用的应用程序名称。 Github页面由我存储库中docs文件夹内的index.html文件支持。我有什么解决方案可以实现这一目标吗?

1 个答案:

答案 0 :(得分:0)

Github Pages仅提供静态文件,但是您可以使用Jekyll根据您的数据生成这些静态文件。为此,请将您的YAML文件放在_data中,然后按照here所述,使用Liquid模板生成HTML。 here提供了有关将Jekyll与Github Pages结合使用的常规信息。

对于搜索栏,您需要使用客户端JavaScript。只需使用class将每个应用程序的元素分组,以便您可以使用JS查询它们,然后根据搜索到的术语显示或隐藏它们。您还可以生成静态JSON文件,该文件包含从数据中获取Liquid的所有信息,然后使用JS加载和处理该客户端。最后,您可以将YAML文件本身提供给客户端,并使用js-yaml加载它。

相关问题