我要发布一个教程,其中包含了很多代码和文档。 我正在考虑两种托管代码的方式:
- 使用单独的git存储库,其中包含代码文件和解释代码的markdown文件
- Github Gist包含这两者
使用Gist与使用存储库相比有哪些优势? 在什么情况下会更喜欢其中之一?
Gist是一种简单的方式,可以与他人分享代码段和粘贴内容。 而仓库则只是一个存储您工作历史记录的地方。
没有标准答案,这取决于个人喜好。我区分它们的概念。如果代码是为了演示技术、教授原理或展示解决方案而设计的,则放在Gist中。无论是一个文件还是30个文件都无所谓。如果它是实际的代码,旨在直接运行、使用或作为样板进行派生,则将其放入适当的代码库中。
自 2021 年 4 月起,Github 存储库中创建的 .md 文件现在包括自动目录,大大提高了可导航性。有关更多信息,请参见此相关 SO 答案。
据我所知,在 gist 创建的 .md 文件中不存在此自动 ToC,因此在这种情况下,我更愿意选择存储库(OP 提到“与文档穿插的大量代码”)。