要点与。教程存储库
Gist Vs. Repository for Tutorial
我正在发布一个教程，其中包含大量代码和文档。我正在考虑两种托管代码的方式：
- 单独的 git 存储库，其中包含代码文件和解释代码的 markdown 文件
- Github 包含这两个的要点
在 gist v/s 存储库中托管有优势吗？什么时候人们会更喜欢其中之一？
Gist 是一种与他人共享片段和粘贴的简单方法。
而 Repo 只是一个存储您的工作历史的地方。
没有好的答案，看个人喜好。我使我的概念上的区别。如果它的代码旨在演示一种技术、教授一种原则或展示一种解决方案，那么它就会成为要点。不管是一个文件还是 30 个文件。如果它是打算 运行、按原样使用或作为样板分叉的实际代码，我会将其放在适当的存储库中。
如果您在教程中使用 markdown 文件，现在有一个重要的区别，即使您只创建一个文件（特别是如果它很长）。
Since April 2021, .md files created in github repositories now include an automatic Table of Contents which greatly improves navegability. See this related SO answer 了解更多信息。
据我所知，这个自动目录在 gist-created .md 文件中不存在，所以在这种情况下我宁愿去一个存储库（OP 提到“很多代码穿插在文档中").
我正在发布一个教程，其中包含大量代码和文档。我正在考虑两种托管代码的方式：
- 单独的 git 存储库，其中包含代码文件和解释代码的 markdown 文件
- Github 包含这两个的要点
在 gist v/s 存储库中托管有优势吗？什么时候人们会更喜欢其中之一？
Gist 是一种与他人共享片段和粘贴的简单方法。 而 Repo 只是一个存储您的工作历史的地方。
没有好的答案，看个人喜好。我使我的概念上的区别。如果它的代码旨在演示一种技术、教授一种原则或展示一种解决方案，那么它就会成为要点。不管是一个文件还是 30 个文件。如果它是打算 运行、按原样使用或作为样板分叉的实际代码，我会将其放在适当的存储库中。
如果您在教程中使用 markdown 文件，现在有一个重要的区别，即使您只创建一个文件（特别是如果它很长）。
Since April 2021, .md files created in github repositories now include an automatic Table of Contents which greatly improves navegability. See this related SO answer 了解更多信息。
据我所知，这个自动目录在 gist-created .md 文件中不存在，所以在这种情况下我宁愿去一个存储库（OP 提到“很多代码穿插在文档中").