我不确定这是否可行,但这是我想做的事情:
我想在github上创建一个literate program,并在我的github的项目页面上自动发布由此产生的人性化文献。通过“自动发布”,我的意思是我可以在我的本地机器上运行一个以“git push origin master”结尾的脚本,并最终在github上发布一个包含数据的人类友好文档。我愿意在程序上达成妥协,但更简单,更好。
很多人不知道文字编程是什么,所以我会总结一下。这是一个系统,您可以在其中编写单个文档,该文档可以转换为源代码或人性化文档。目的是用英语(或其他自然语言)非常清楚地解释算法,并且当用户可能对阅读您的算法感兴趣时,它被认为是有用的,因为他们直接使用它。有些人(如Donald Knuth)认为文学编程是构建任何复杂软件的关键工具。
这样做的一个想法是生成类似README.md文件的文件作为文字程序的输出,但我不知道github的降价格式中的任何数学支持。看起来像github的wiki可能支持一些数学,但我不知道如何从代码中生成wiki - 就像在,我希望能够从我的机器上做git push origin master
,并自动更新github wiki。
(另外,要理解为什么数学支持很重要:我来自一个总是使用TeX或LaTeX来撰写论文的世界,而且我对其他作者习惯使用LaTeX的一般系统感兴趣。 )
任何想法如何实现这一目标?
答案 0 :(得分:1)
wiki由他们自己的git repo支持,所以你可以推送它并让它自动更新。这是一个不同于主要回购的回购。据我所知,只有wiki支持的东西,而不是主要的repo降价处理器。