我想在github上发布一系列编程教程以及一些代码。教程将以markdown编写。将有几个降价文件相互引用。
现在我想知道什么是最好的选择:
我对github页面以及github wiki不是很熟悉,所以在这种情况下任何关于(dis)优点的暗示都是有帮助的!
答案 0 :(得分:3)
你已经提到了三种不同的方法,我会详细说明每一种......
这种方法实际上并不是太糟糕,因为只要他们知道Markdown(并且Markdown很容易学习),人们就可以为此做出贡献,因为他们只需要在分叉后发送拉取请求库。此外,由于Github使用了一个名为Github Flavored Markdown的东西,你可以将代码直接嵌入到每个文件中,并有一些漂亮的语法高亮显示。
使用Github wiki是一个可行的选择,因为它可以让其他人轻松地为它做出贡献。但是,您可能更愿意在批准类型系统上对其他人进行更改,这是因为提取请求功能而使用第一个选项。我个人不建议您纯粹使用wiki,因为它破坏了Github存储库本身(在wiki中有一个带有堆的空存储库)。这只是我个人的意见。
你可以使用Github Pages生成器并使用它生成一个网站。但是我想指出它使用Jekyll来生成网站,并且生成器只会自动创建一个页面,其余的页面将由你来使用Markdown和一些HTML。它会看起来更好,但会耗费更多时间。
我建议您将教程本身托管在用Markdown编写的Github存储库中,然后您可以使用页面生成器创建一个页面,该页面生成器将链接到教程的所有部分(充当着陆页)< / p>