创建GitHub仓库
- 打开GitHub,进入“用户”页面。
- 点击“Create New”来创建一个新仓库。
- 选择仓库名称,通常可以使用一个有意义的标题,如“my_project”。
- 在仓库中添加代码、Markdown文件(如草稿、文档)和日志(如git logs)。
上传代码
- 在仓库中创建一个新文件夹,格式为
index.md。 - 编写代码,并在末尾添加 Markdown 格式的内容(如代码示例、解释、注释等)。
- 使用代码blocks或其他格式支持的 Markdown 格式来格式化代码。
使用Markdown
- Markdown 是GitHub常用的Markdown编辑器,支持包括代码块、标题、列表、链接等。
- 在仓库中创建一个新文件夹,使用 Markdown 格式编写内容,
# My Project # Description of the project. {code} # Example code function hello() { return "Hello, World!"; }
使用Git日志
- 使用
git log查看代码变更日志。 - 在仓库中创建
.gitignore文件,指定哪些内容不会被记录(如原始代码、依赖包等)。 - 使用
git log --porcelain可以得到格式化且易于读取的 Git 日志。
分享和协作
- 在仓库中创建一个 public 文件夹(如
public/index.md),这样仓库可以在其他平台(如 PyCharm、Jupyter Notebook 等)访问。 - 在仓库中创建一个 public 记录(如
public/repo.md),记录仓库的名称和名称标签。 - 在仓库中创建一个 public 代码块(如
public/代码块.md),将代码和块一起上传到仓库。
常见问题与技巧
- 如何在GitHub上使用Markdown:在仓库中创建一个
.md文件,使用 Markdown 格式编写内容。 - 如何在GitHub上使用Git日志:确保
gitignore文件正确无误,使用git log --porcelain查看日志。 - 如何在GitHub上使用代码库:将仓库中的代码和文档存储在 GitHub 代码库中,以便在其他平台访问。
通过以上步骤,你可以有效地在GitHub上进行科学上网,管理代码和文档,与其他开发者协作和分享代码。
