GitHub 使用指南
GitHub GuidesGitHub 仓库
  • GitHub 使用指南
  • Hello World
    • 简介
    • 什么是 GitHub?
    • 创建一个仓库
    • 创建一个分支
    • 修改并提交更改
    • 发起拉取请求
    • 合并拉取请求
  • 理解 GitHub 工作流
    • 简介
    • 创建分支
    • 提交更改
    • 发起拉取请求
    • 讨论并评审代码
    • 部署
    • 合并
  • GitHub Pages 入门
    • 简介
    • 创建你的网站
    • 做一些修改
    • 下一步
  • Git 手册
    • 简介
    • 什么是版本控制系统?
    • 什么是仓库?
    • Git 基础
    • GitHub
  • 复刻他人项目
    • 简介
    • 为项目做贡献
    • 复刻仓库
    • 克隆你所复刻的项目
    • 修改并推送
    • 发起拉取请求
  • 多多社交
    • 简介
    • 关注一个朋友
    • 查看一个项目仓库
    • 你可以做更多的事情
  • 使代码可引用
    • 简介
    • 选择你的仓库
    • 登录 Zenodo
    • 查看仓库设置
    • 发布新版本
    • 创建 DOI
    • 即将完成
  • 精通 Issues
    • 简介
    • 里程碑,标签和被指派人
    • 通知,@提及 和引用
    • 搜索
    • 概述 & 报告
    • Issues 的其他用途
  • 精通 Markdown
    • 简介
    • 什么是 Markdown?
    • 例子
    • 语法指南
    • GitHub 风味 Markdown
  • 项目文档化
    • 简介
    • 创建你的 README
    • 格式化你的 README
    • 创建你的 wiki
    • 添加内容
    • 添加页面
    • 语法高亮
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. 项目文档化

语法高亮

Wiki 页面支持使用以下自动语法高亮突出显示各种语言的代码:

```ruby
  def foo
    puts 'bar'
  end

该块必须以三个反引号开始,可选地后跟着该块包含的语言的名称。有关可以语法高亮的语言列表,请参阅 [Pygments 支持的语言列表](http://pygments.org/docs/lexers/)。

块内容应缩进到与起始反引号相同的程度。该块必须以与起始反引号相同缩进程度的三个反引号结束。

### 完成了!

你已经了解了一些有关如何最好地与 GitHub 社区的其他人分享关于你的工作的重要信息,无论你的项目是否足够庞大,还是你只是刚刚开始并设置一个清晰简洁的 README 文件。

要阅读有关本文所涵盖主题的更多信息,我们的 [创建新仓库](https://help.github.com/articles/creating-a-new-repository/)、[编辑仓库中的文件](https://help.github.com/articles/editing-files-in-your-repository/)、[为仓库贡献者设置指南](https://help.github.com/articles/setting-guidelines-for-repository-contributors/) 以及 [选择许可证](http://choosealicense.com/) 是很好的起点。或者,请查看其他的 [GitHub 指南](https://itechub.gitbook.io/github-guides-zhcn) 以继续学习。

最后,如果你对为项目构建文档网站感兴趣,我们建议你使用 [GitHub Pages](https://pages.github.com/)。  

Previous添加页面

Last updated 2 years ago

Was this helpful?