diff --git a/.gitignore b/.gitignore
deleted file mode 100644
index bf3f68f..0000000
--- a/.gitignore
+++ /dev/null
@@ -1 +0,0 @@
-_version.inc
diff --git a/.gitmodules b/.gitmodules
deleted file mode 100644
index c3b7121..0000000
--- a/.gitmodules
+++ /dev/null
@@ -1,3 +0,0 @@
-[submodule "graphics"]
- path = graphics
- url = git://github.com/gotgit/gotgithub-graphics.git
diff --git a/01-explore-github/010-what-is-github.rst b/01-explore-github/010-what-is-github.rst
index 396c171..96e5ea3 100644
--- a/01-explore-github/010-what-is-github.rst
+++ b/01-explore-github/010-what-is-github.rst
@@ -1,90 +1,43 @@
-.. _what-is-github:
+什么是GitHub
+================
-==============
- 什么是GitHub
-==============
-GitHub(网址 https://github.com/\ )是一个面向开源及私有软件项目的托管平台,\
-因为只支持Git作为唯一的版本库格式进行托管,故名GitHub。
+GitHub,网址 https://github.com/ ,是一个开源软件项目的托管平台,因为只使用Git作为唯一的版本库格式进行版本库托管,故名GitHub。GitHub的注册用户已经接近百万,托管的版本库数量已超两百万,其中不乏知名的开源项目,如:Ruby on Rails [#]_ ,Hibernate [#]_ ,phpBB [#]_ ,jQuery [#]_ ,Prototype [#]_ ,Homebrew [#]_ 等。
-
-GitHub的注册用户已经超过百万\ [#]_\ ,托管的版本库数量已超三百万,其中不乏知\
-名的开源项目,如:Ruby on Rails\ [#]_\ 、Hibernate\ [#]_\ 、phpBB\ [#]_\ 、\
-jQuery\ [#]_\ 、Prototype\ [#]_\ 、Homebrew\ [#]_\ 等。
-
-GitHub于2008年4月10日正式发布\ [#]_\ ,相比始于1999年的SourceForge\ [#]_\ 和\
-2005年的GoogleCode\ [#]_\ ,GitHub后来者居上。以2011年的数据从代码提交数量上\
-看,GitHub已经超越其前辈\ [#]_\ ,如图1-1所示。
+GitHub于2008年4月10日正式发布 [#]_ ,相比于始于1999年的SourceForge [#]_ 和2005年的GoogleCode [#]_ ,GitHub后来者居上,从代码提交数量上看,GitHub已经超越其前辈 [#]_ ,如图1-1所示。
.. figure:: /images/explore-github/survival-of-the-forges.png
:scale: 100
图1-1:开源项目托管平台提交数量对照
-对于一个开源项目,从开发角度讲大体上分为两类人群,一类称为核心开发团队,他们\
-可以向保存源代码的版本库提交,即对源代码的修改具有最终的决定权。另外一类称为\
-贡献者,他们不属于核心开发团队,虽然也能看到源代码,但无权向版本库提交修改。
-
-.. _cvcs-model:
+对于一个开源项目,从开发角度讲大体上分为两类人群,一类称为核心开发团队,他们可以向保存源代码的版本库提交,即对源代码的修改具有最终的决定权。另外一类称为贡献者,他们不是核心团队的成员,虽然也能看到源代码,但是只可读不可写。
-采用传统的集中式版本控制系统(如SVN)的开源项目,这两个群体的用户体验都不是\
-太好。如图1-2所示,项目的贡献者(非核心成员)很不“高兴”,因为他们即便有修改\
-源代码的能力和渴望,也不能直接向版本库提交,要想成为提交者需要一个很长的建立\
-信任的过程。然而即便是核心开发团队的成员,体验也不是太好,因为凡是涉及到版本\
-库的操作(检入、检出、查看日志等)都需要在联网的状态下进行,网络带宽对用户\
-体验影响相当大。
+采用传统的集中式版本控制系统(如SVN)的开源项目,这两个群体的用户体验都不是太好。如图1-2所示,项目的贡献者(非核心成员)很不“高兴”,因为他们即便有修改代码的能力和渴望,也不能直接向版本库提交,要想成为提交者需要一个很长的建立信任的过程。对于项目的核心开发团队,体验也不是很好,因为凡是涉及到版本库的操作(检入、检出、查看日志等)都需要在联网的状态下运行,网络带宽对用户体验影响相当大。
-.. figure:: /images/explore-github/cvcs-model.png
+.. figure:: /images/explore-github/svn-workflow.png
:scale: 100
图1-2:使用集中式版本控制系统
-.. _dvcs-model:
+Git等分布式版本控制系统的出现,彻底颠覆了原有代码管理的管理模式和组织架构。使用Git,不再需要唯一的、集中式的版本库,而是每个开发者本地都拥有一份完整的版本库克隆。Git并不排斥集中式的使用模式,但更倾向于将集中式模式下的版本库称为共享版本库,核心开发团队的成员可以将自己本地版本库的提交推送到共享版本库上。
-Git等分布式版本控制系统的出现,彻底颠覆了原有代码管理的组织模式。使用Git,\
-不再依赖唯一的、集中式的版本库,而是每个开发者本地都拥有一份完整的版本库。\
-Git并不排斥集中式的使用模式,但更倾向于将集中式版本库称为共享版本库。核心\
-开发团队的成员和贡献者(非核心成员)都可以从共享版本库克隆一份本地版本库,\
-但只有核心团队成员才可以将自己本地版本库的提交推送到共享版本库上。\
-如图1-3所示。
+使用Git做版本控制,如图1-3所示,核心开发团队非常“高兴”,因为他们和共享版本库之间不必一直保持连接状态,诸如查看日志、提交、创建分支等几乎全部操作都(脱离网络)在本地的版本库中完成。项目贡献者(非核心成员)也不再那么沮丧,因为版本库人人皆可更改(当然是对本地版本库而言)。稍微让贡献者感到困难的就是如何将自己的改动被核心开发团队所了解并接纳。Git提供了多种途径,一个方法是先用 ``git-format-patch`` 命令将本地提交转换为补丁文件或补丁文件序列,再通过邮件发送给核心开发团队。另外一个办法就是搭建一个自己专有的共享版本库,让核心团队的开发者到自己共享的版本库来抓取(Pull)。自己动手搭建Git服务器建立共享版本库是一个难点,在我的
+《Git权威指南》一书中花了七个章节来介绍,掌握起来有一定难度。
-.. figure:: /images/explore-github/dvcs-model.png
+.. figure:: /images/explore-github/git-workflow.png
:scale: 100
图1-3:使用分布式版本控制系统
-使用Git做版本控制(如图1-3所示),核心开发团队非常“高兴”,因为他们和共享\
-版本库之间不必一直保持连接状态,诸如查看日志、提交、创建分支等几乎全部操作\
-都(脱离网络)在本地的版本库中完成。项目贡献者(非核心成员)也不再那么沮丧,\
-因为版本库人人皆可更改(当然是对本地版本库而言)。稍微让贡献者感到困难的就是\
-如何将自己对项目的改进被核心开发团队所了解并接纳。Git提供了多种途径,一个方法\
-是先用\ ``git format-patch``\ 命令将本地提交转换为补丁文件或补丁文件序列,再\
-通过邮件发送给核心开发团队。另外一个办法就是搭建一个自己专有的共享版本库,\
-通过邮件创建一个拉拽请求(Pull Request),让核心团队的开发者到自己的版本库来\
-抓取(Pull)。
+GitHub的出现极大地改善了开源项目的生态环境,无论项目的核心开发团队,还是普通的项目贡献者都工作得非常“愉快”。项目的创建者只需在GitHub上点击一下鼠标即可创建一个新版本库。普通的项目贡献者在GitHub上先找到自己希望参与的项目,然后只需点击一下鼠标即可在自己的托管空间下创建一个派生的版本库(即项目分支),就好像这个项目原本就是由自己创立的那样。如图1-4所示,当普通的项目贡献者完成开发,可以通过GitHub的Web界面向项目的核心开发团队发送一个拖拽请求(Pull Request),项目的核心团队收到 Pull Request 后审核代码,审核通过后可以直接点击Web界面上的合并按钮完成对贡献者代码的合并。
-.. _github-model:
-
-GitHub的出现进一步推动了Git的普及,简化了版本控制的管理和操作流程,为开发者\
-提供了更好的交流平台。如图1-4所示。
-
-.. figure:: /images/explore-github/github-model.png
+.. figure:: /images/explore-github/github-workflow.png
:scale: 100
图1-4:GitHub的协同模式
-使用GitHub,无论是项目的核心开发团队,还是普通的项目贡献者都工作得非常“愉快”。\
-创建项目变得非常轻松,创建者只需在GitHub上点击一下鼠标即可创建一个新版本库,\
-通过简单的Web操作即可完成项目授权进而组建项目核心团队。在GitHub中,\
-非核心团队成员参与项目也很容易。先找到自己希望参与的项目,然后只需在Web\
-上点击一下鼠标即可在自己的托管空间下创建一个派生(fork)的项目,\
-并对派生项目的版本库具有读写的完全权限,就好像这个项目原本就是由自己创立的\
-那样。当贡献者完成开发并向自己派生的版本库推送后,可以通过GitHub的Web界面向\
-项目的核心开发团队发送一个Pull Request,请求审核。项目的核心团队收到\
-Pull Request后审核代码,审核通过后可以直接通过Web界面执行合并操作接纳贡献者的提交。
-
----
-.. [#] https://github.com/blog/936-one-million
.. [#] https://github.com/rails/rails
.. [#] https://github.com/hibernate
.. [#] https://github.com/phpbb/phpbb3
diff --git a/01-explore-github/020-github-hightlights.rst b/01-explore-github/020-github-hightlights.rst
index d56391f..6a87a17 100644
--- a/01-explore-github/020-github-hightlights.rst
+++ b/01-explore-github/020-github-hightlights.rst
@@ -1,5 +1,3 @@
-.. _github-hightlights:
-
GitHub亮点
===============
@@ -7,55 +5,34 @@ GitHub亮点
1. 只用Git。
- GitHub只支持Git格式的版本库托管,而不像其他开源项目托管平台还对CVS、SVN、\
- Hg等格式的版本库进行托管。GitHub的哲学很简单,既然Git是最好的版本控制系统\
- 之一(对于很多喜欢Git和GitHub的人没有之一),没有必要为兼顾其他版本控制\
- 系统而牺牲Git某些独有特性。因此没有支持其他版本控制系统的历史负担,\
- 是GitHub成功的要素之一。
+ GitHub只支持Git格式的版本库托管,而不像其他开源项目托管平台还对CVS、SVN、Hg等格式的版本库进行托管。GitHub的哲学很简单,既然Git是最好的版本控制系统之一(对于喜欢GitHub的人没有之一),没有必要为兼顾其他版本控制系统而牺牲Git某些独有特性。因此没有支持其他版本控制系统的历史负担,是GitHub成功的要素之一。
- 只用Git并不是说GitHub完全无视其他版本控制系统的使用者,相反,GitHub面向\
- SVN(Subversion)用户和Hg(Mercurial)用户开发了接口,让这些用户可以使用\
- SVN或Hg的客户端工具访问Git版本库。
+ 只用Git并不是说GitHub完全无视其他版本控制系统的使用者,相反,GitHub面向SVN(Subversion)用户和Hg(Mercurial)用户开发了接口,让这些用户可以使用SVN或Hg的客户端工具访问Git版本库。
2. 对Git的完整支持。
- 相比其他开源项目托管平台,GitHub对Git版本库提供了完整的协议支持,支持HTTP\
- 智能协议、Git-daemon、SSH协议。相比只支持HTTP协议的GoogleCode,GitHub\
- 通过SSH协议可以实现版本库访问的无口令认证\ [#]_\ 。
+ 相比其他开源项目托管平台,GitHub对Git版本库提供了完整的协议支持,支持HTTP智能协议、Git-daemon、SSH协议。相比只支持HTTP协议的GoogleCode,GitHub通过SSH协议可以实现版本库访问的无口令认证。
3. 无处不在的Git。
- 除了在版本库托管上使用Git,Git还被GitHub应用到更多领域。维基使用Git,\
- 可以通过克隆维基所在的版本库,离线修改维基;在线粘贴数据的Gist网站\ [#]_\
- 使用Git,记录变更历史;以及在Jekyll应用的帮助下,用Git版本库维护个人网站\
- 和博客等。
+ 除了在版本库托管上使用Git,Git还被应用到GitHub更多的领域。维基使用Git,可以通过克隆维基所在的版本库,线下修改维基。在线粘贴信息的Gist网站 [#]_ 使用Git,记录变更历史。在Jekyll应用的帮助下,可以用Git版本库维护个人网站和博客。
4. 在线编辑文件。
- GitHub提供了在线编辑文件的功能,不熟悉Git的用户也可以直接通过浏览器修改\
- 版本库里的文件。
+ GitHub提供了在线编辑文件的功能,即使不熟悉Git的用户也可以直接修改版本库里的文件。
5. 社交编程。
- 将社交网络引入项目托管平台是GitHub的创举。用户可以关注项目、关注其他用户\
- 进而了解项目和开发者动态。项目的派生(Fork)和拉拽请求(Pull Request)\
- 构成GitHub最独具一格的工作模式。对提交代码的逐行评注及Pull Request构成了\
- GitHub特色的代码审核。
+ 将社交网络引入项目托管平台是GitHub的创举。用户可以关注项目、关注其他用户进而了解项目和开发者动态。项目的派生(Fork)和拉拽请求(Pull Request)构成GitHub最独具一格的工作模式。对提交代码的逐行评注及Pull Request构成了GitHub特色的代码审核。
6. 商业上的成功。
- GitHub通过私有版本库托管、面向企业的版本库托管和项目管理平台、人员招聘等\
- 付费服务获得了商业上的成功,这种成功使得GitHub不必以页面中嵌入广告的方式\
- 维持运营,最大的受益者还是用户。
+ GitHub通过私有版本库托管、面向企业的版本库托管、人员招聘等付费服务获得了商业上的成功,这种成功使得GitHub不必以页面中嵌入广告的方式维持运营,最大的受益者还是用户。
7. 关注细节。
- GitHub网站采用了Ruby on Rails架构,在Web设计中运用了大量的JavaScript、\
- AJAX、HTML5等技术,支持对使用Markdown等标记语言的内容进行渲染和显示等。\
- 关注细节使得GitHub成为了项目托管领域的后起之秀。
+ GitHub网站采用了Ruby on Rails的架构,在Web设计中运用了大量的JavaScript、AJAX、HTML5等技术,支持使用了Markdown等标记语言的文件自动渲染和显示,等等。关注细节使得GitHub成为了项目托管领域的后起之秀。
----
-.. [#] 实际上使用HTTP协议也可以免口令输入。即通过文件\ ``~/.netrc``\ 写入\
- HTTP认证的明文口令。具体文件格式参见\ ``ftp``\ 命令MAN手册中相关介绍。
.. [#] https://gist.github.com/
diff --git a/01-explore-github/030-explore-github.rst b/01-explore-github/030-explore-github.rst
index 832bdf9..c2e2b21 100644
--- a/01-explore-github/030-explore-github.rst
+++ b/01-explore-github/030-explore-github.rst
@@ -1,11 +1,7 @@
-.. _explore-github:
-
探索GitHub
===============
-打开浏览器,访问网址 https://github.com/\ ,来探索GitHub吧。GitHub的首页\
-(图1-5所示)特意给出了Git和GitHub的音标,可能不少国人需要据此校准一下\
-Git的读音\ [#]_\ 。
+打开浏览器,访问网址 https://github.com/ 来探索GitHub吧。GitHub的首页(图1-5所示)特意给出了Git和GitHub的音标,可能不少国人需要据此校准一下Git的读音 [#]_ 。
.. figure:: /images/explore-github/github-homepage.png
:scale: 100
@@ -13,29 +9,24 @@ Git的读音\ [#]_\ 。
图1-5:GitHub的首页
-在首页的右上角是导航条,从左至右分别是:注册和收费方案、探索GitHub、功能、\
-博客和登录。还醒目地显示出不断增长着的注册用户数和托管的版本库数目。
+在首页的右上角是导航条,从左至右分别是:收费方案和注册、探索GitHub、功能、博客和登录。还醒目地显示出不断增长着的注册用户数和托管的版本库数目。
-如果想要了解GitHub上哪些项目最热门,进而寻找到好的开源产品,那么可以从导航条\
-中的“Explore GitHub”开始。图1-6显示通过对社交数据的分析得到的托管版本库动态趋势。
+如果想要了解GitHub上哪些项目最热门,进而寻找到好的开源产品,那么可以从导航条中的“Explore GitHub”开始。图1-6显示通过对社交数据的分析得到的托管版本库动态趋势。
.. figure:: /images/explore-github/explore-trends.png
:scale: 100
图1-6:版本库动态趋势
-还可以根据感兴趣的人数、建立分支的数量、关注程度等寻找热门项目。图1-7显示\
-分支最多的项目是Homebrew —— 一款用ruby开发的苹果Mac OS X通用的非官方包管理\
-软件。考虑到不断攀升的苹果用户数量以及易于上手的ruby语言,这并不奇怪。
+还可以根据感兴趣的人数、建立分支的数量、关注程度等寻找热门项目。图1-7显示分支最多的项目是Homebrew —— 一款用ruby开发的苹果Mac OS X通用的非官方包管理软件。考虑到不断攀升的苹果用户数量以及易于上手的ruby语言,这并不奇怪。
.. figure:: /images/explore-github/explore-repositories.png
:scale: 100
图1-7:热门版本库排行
-图1-8显示了托管版本库所用编程语言的动态分布,程序员多掌握几个热门编程语言\
-一定会对找工作有帮助。;-)
+图1-8显示了托管版本库所用编程语言的动态分布,多掌握几个热门编程语言一定会对找工作有帮助。;-)
.. figure:: /images/explore-github/explore-languages.png
:scale: 100
@@ -43,34 +34,24 @@ Git的读音\ [#]_\ 。
图1-8:托管项目的编程语言统计
-GitHub通过屏幕截图等方式介绍了GitHub的常见功能,可以通过点击导航条中的\
-“Features”访问到。如图1-9可以看到在项目管理中,如何利用GitHub提供的团队管理\
-功能、维基、缺陷追踪以及代码审核。
+GitHub通过屏幕截图等方式介绍了GitHub的常见功能,可以通过点击导航条中的“Features”访问到。如图1-9可以看到在项目管理中,如何利用GitHub提供的团队管理功能、维基、缺陷追踪以及代码审核。
.. figure:: /images/explore-github/features-pm.png
:scale: 100
图1-9:GitHub功能介绍
-.. _blog:
-
-博客也是了解GitHub的一个重要的途径,可以获知GitHub的最新动态,如最新改进等。\
-图1-10显示的是GitHub在感恩节推出的促销活动:收费服务免费试用一个月!\ [#]_\
-如果及时关注博客就不会错过噢。
-
-.. _octocat:
+博客也是了解GitHub的一个重要的途径,可以获知GitHub的最新动态,如最新改进等。图1-10显示的是GitHub在感恩节推出的促销活动:收费服务免费试用一个月!如果及时关注博客就不会错过噢。
.. figure:: /images/explore-github/blog.png
:scale: 100
图1-10:GitHub博客
-图1-10的博客中一个由小章鱼和小猫组合而成的吉祥物,名字叫做Octocat。这个可爱的\
-GitHub吉祥物时不时会出来带给你惊喜。
+图1-10的博客中一个由小章鱼和小猫组合而成的吉祥物,名字叫做Octocat。这个可爱的GitHub吉祥物时不时会出来带给你惊喜。
马上到GitHub上注册,开始GitHub之旅。
----
-.. [#] 《Git权威指南》第1页就提到了两种常见的对Git的读音错误。
-.. [#] http://git.io/N9WJ5w
+.. [#] 《Git权威指南》第1页。
diff --git a/01-explore-github/index.rst b/01-explore-github/index.rst
index be1f759..29d607a 100644
--- a/01-explore-github/index.rst
+++ b/01-explore-github/index.rst
@@ -1,9 +1,6 @@
-.. _github-overview:
-
探索GitHub
********************
-熟悉Git\ [#]_\ 的人几乎都知道并喜欢GitHub\ [#]_\ ,反过来GitHub也吸引更多的\
-人来使用Git。GitHub正在成为开源项目托管的主要平台,是什么成就了GitHub?
+熟悉Git [#]_ 的人几乎都知道并喜欢GitHub [#]_ ,反过来GitHub也吸引更多的人来使用Git。GitHub正在成为开源项目托管的主要平台,是什么成就了GitHub?
.. toctree::
:maxdepth: 1
@@ -14,9 +11,9 @@
.. seealso::
- 本书并非一本介绍Git的书,并且假设读者已经掌握了Git的相关操作。如果读者对\
- Git尚不了解,可以参考我写的 《Git权威指南》\ [#]_\ 一书。此外还可以从网上\
- 找到很多免费的、很好的Git资料,如:Git社区书\ [#]_\ 、Pro Git\ [#]_\ 等。
+ 本书并非一本介绍Git的书,并且假设读者已经掌握了Git的相关操作。
+ 如果读者对Git尚不了解,可以参考我写的《Git权威指南》一书 [#]_ 。此外还可以从网上找到很多免费的、很好的Git资料,
+ 如:Git社区书 [#]_ 、Progit [#]_ 等。
----
diff --git a/02-join-github/010-account-setup.rst b/02-join-github/010-account-setup.rst
index d82f7b9..5d57068 100644
--- a/02-join-github/010-account-setup.rst
+++ b/02-join-github/010-account-setup.rst
@@ -1,141 +1,85 @@
-.. _github-signup:
-
创建GitHub账号
===============
-注册GitHub账号,只要点击导航条中的“Signup and Pricing”,或者点击首页中那个\
-大大的“Plans, Pricing and Signup”按钮,即进入收费方案介绍及注册页面。
+注册GitHub账号,只要点击导航条中的“Pricing and Signup”,或者点击首页中那个大大的“Plans,Pricing and Signup”按钮,即进入收费方案介绍及注册页面。
-收费?不必担心,开源软件托管是GitHub的基石,对于开源项目的版本库(即非私有\
-版本库)的托管,GitHub是免费的。在收费方案及注册页面中,最上面的就是针对于\
-开源的免费托管方案,如图2-1所示。
+收费?不必担心,开源软件托管是GitHub的基石,对于开源项目的版本库(即非私有版本库)的托管,GitHub是免费的。在收费方案及注册页面中,最上面的就是针对于开源的免费托管方案,如图2-1所示。
.. figure:: /images/join-github/free-plan.png
:scale: 100
图2-1:针对开源项目(公开版本库)的免费方案
-至于本页其他付费方案,将在后面的章节介绍。点击免费方案右侧的\
-“Create a free account”按钮,就进入到注册页面,如图2-2所示。
+至于本页其他付费方案,将在后面的章节介绍。点击免费方案右侧的“Create a free account”按钮,就进入到注册页面,如图2-2所示。
.. figure:: /images/join-github/signup.png
:scale: 100
图2-2:账号注册
-GitHub的注册页面非常简洁,只有登录ID,邮件地址和口令需要输入。要注意的是\
-每个邮件地址只能注册一次。
-
-注册完毕即以新注册的账号自动登录。登录后即进入用户的仪表板(Dashborad)\
-页面。首次进入的仪表板页面还会在其中显示GitHub BootCamp(GitHub 新手训练营)\
-的链接,以帮助新用户快速入门。如果图2-3所示。
+GitHub的注册页面非常简洁,只有登录ID,邮件地址和口令需要输入。要注意的是每个邮件地址只能注册一次。注册完毕即以新注册的账号自动登录,图2-3是以新注册的gotgithub用户登录后的首页。在首页右上方的导航条,可以看到当前登录用户的名称,如图2-3中显示为gotgithub。在登录用户名称前显示用户照片,因为尚未设置所以显示为缺省图片——GitHub吉祥物Octocat的剪影。点击导航条中的“Account Settings”,对账号进行进一步设置。
.. figure:: /images/join-github/loggedin.png
:scale: 100
图2-3:登录后的GitHub首页
-仪表板页面是用户最重要的页面,因为创建新项目(新版本库)的链接就位于该页面。\
-重新设计的GitHub用户界面\ [#]_\ 中跳转到仪表板页面的链接不像之前那么直观,\
-鼠标移动到页面左上角的“github”文字图标会发现此图标可以点击,该文字图标即是\
-进入仪表板页面的快捷。
+图2-4对用户公开身份信息进行设置,所有内容均为可选项,如果填写将显示在个人页面中,并能被所有人访问。注意修改用户头像需要访问第三方头像设置网站:gravatar.com。Gravatar网站提供的头像服务是一个通用服务,可为大部分Web应用所使用。
-在页面右上方显示当前登录用户的名称和头像。图2-3中显示登录用户为 gotgithub,\
-而用户头像因为尚未设置所以显示为缺省图片——GitHub吉祥物Octocat的剪影。在页面\
-右上方还有三个图标,从左至右分别是:通知、账号设置和退出。点击账号设置图标\
-对账号进行进一步设置,如图2-4所示。
+图2-4中还显示了当前用户使用的GitHub托管方案(Free)和使用统计。因为当前注册用户选择的是免费方案,所以可用的私有版本库数量和私有空间协同者数目都是零。免费方案拥有300MB托管空间,因当前尚未创建版本库托管,所以空间占用为零。GitHub对开源软件的300MB托管空间限制并非硬性限制,可以申请扩增托管空间,如果不存在滥用情况的话。
.. figure:: /images/join-github/setting-profile.png
:scale: 100
图2-4:账户设置页
-账号设置的第一个页面是对用户公开身份信息进行设置,所有内容均为可选项,如果\
-填写将显示在个人页面中,并能被所有人访问。注意修改用户头像需要访问第三方\
-头像设置网站:\ `gravatar.com`_\ ,Gravatar网站提供的头像服务是一个通用服务,\
-可为大部分Web应用所使用。
-
-图2-4中还显示了当前用户使用的GitHub托管方案(Free)和使用统计。因为当前注册\
-用户选择的是免费方案,所以可用的私有版本库数量和私有空间的协同者数目都是零。\
-免费方案拥有300MB托管空间,因当前尚未创建版本库托管,所以空间占用为零。\
-GitHub对开源软件的300MB托管空间限制并非硬性限制,可以申请扩增托管空间,如果\
-不存在滥用情况的话。
-
-点击菜单中的“Account Admin”,可以更改口令、查看API Token、修改用户名,以及\
-删除自身账号,如图2-5所示。
+点击菜单中的“Account Admin”,可以更改口令、查看API Token、修改用户名,以及删除自身账号,如图2-5所示。
.. figure:: /images/join-github/setting-admin.png
:scale: 100
图2-5:账户管理
-.. _api-token:
+其中API Token是和用户口令相关的密钥,当用户口令更改时API Token也随之更改。GitHub的某些应用会使用API Token进行身份认证,从而避免直接使用用户口令造成泄露的风险。API Token若泄露的危害要远远小于口令泄露,这因为API Token不能用于登录GitHub网站等,而且一旦API Token泄露可以很容易通过更改口令的方式更换API Token。
-其中API Token是和用户口令相关的密钥,当用户口令更改时API Token也随之更改。\
-GitHub的某些应用会使用API Token进行身份认证,从而避免直接使用用户口令造成\
-泄露的风险。API Token若泄露的危害要远远小于口令泄露,这因为API Token不能用于\
-登录GitHub网站等,而且一旦API Token泄露可以很容易通过更改口令的方式更换\
-API Token。
-
-点击菜单中的“Email Addresses”,可以添加和删除邮件地址,如图2-6所示。GitHub\
-允许为一个账号绑定多个邮件地址,以便能够将Git版本库中的提交\
-(提交者以 "用户名 <邮件地址>" 的格式给出)正确对应到GitHub账户。
+点击菜单中的“Email Addresses”,可以添加和删除邮件地址,如图2-6所示。GitHub允许为一个账号绑定多个邮件地址,以便能够将Git版本库中的提交(提交者以 "用户名 <邮件地址>" 的格式给出)正确对应到GitHub账户。
.. figure:: /images/join-github/setting-email.png
:scale: 100
图2-6:邮件地址管理
-.. _ssh:
-
-GitHub为托管的Git版本库提供SSH协议支持,即用户可以用公钥认证的方式连接到\
-GitHub的SSH服务器。下面的示例用ssh命令连接github.com的SSH服务,登录用户名为\
-git(所有GitHub用户共享此SSH用户名,不要写成其他)。
+GitHub为托管的Git版本库提供SSH协议支持,即用户可以以公钥认证的方式连接到GitHub的SSH服务器。下面的示例用ssh命令连接github.com的SSH服务,登录用户名为git(所有GitHub用户共享此SSH用户名,不要写成其他)。
::
$ ssh -T git@github.com
Permission denied (publickey).
-上面的示例显示登录失败,这是因为我们尚未在GitHub账户中正确设置公钥认证。\
-图2-7显示的是GitHub的SSH公钥设置界面。
+上面的示例显示登录失败,这是因为我们尚未在GitHub账户中正确设置公钥认证。图2-7显示的是GitHub的SSH公钥设置界面。
.. figure:: /images/join-github/setting-ssh.png
:scale: 100
图2-7:SSH公钥管理
-要想向GitHub添加SSH公钥,首先要确保正确生成了对应的公钥/私钥对。关于SSH公钥\
-认证,在我的《Git权威指南》一书的“第29章使用SSH协议”中有详细介绍,这里仅做\
-简要的介绍。
+要想向GitHub添加SSH公钥,首先要确保正确生成了对应的公钥/私钥对。关于SSH公钥认证,在我的《Git权威指南》一书的“第29章使用SSH协议”中有详细介绍,这里仅做简要的介绍。
-GitHub的SSH服务支持OpenSSH格式的公钥认证,可以通过Linux、Mac OS X、或Cygwin\
-下的\ ``ssh-keygen``\ 命令创建公钥/私钥对。命令如下:
+GitHub的SSH服务支持OpenSSH格式的公钥认证,可以通过Linux、Mac OS X、或Cygwin下的 ``ssh-keygen`` 命令创建公钥/私钥对。命令如下:
::
$ ssh-keygen
-然后根据提示在用户主目录下的\ ``.ssh``\ 目录中创建默认的公钥/私钥对文件,\
-其中\ ``~/.ssh/id_rsa``\ 是私钥文件,\ ``~/.ssh/id_rsa.pub``\ 是公钥文件。\
-注意私钥文件要严加保护,不能泄露给任何人。如果在执行\ ``ssh-keygen``\ 命令时\
-选择了使用口令保护私钥,私钥文件是经过加密的。至于公钥文件\
-``~/.ssh/id_rsa.pub``\ 则可以放心地公开给他人。
+然后根据提示在用户主目录下的 .ssh 目录中创建默认的公钥/私钥对文件,其中 ``~/.ssh/id_rsa`` 是私钥文件, ``~/.ssh/id_rsa.pub`` 是公钥文件。注意私钥文件要严加保护,不能泄露给任何人,如果在执行 ``ssh-keygen`` 命令时选择了使用口令保护私钥,私钥文件是经过加密的。公钥文件 ``~/.ssh/id_rsa.pub`` 则可以放心地公开给任何人。
-也可以用\ ``ssh-keygen``\ 命令以不同的名称创建多个公钥,当拥有多个GitHub\
-账号时,非常重要。这是因为虽然一个GitHub账号允许使用多个不同的SSH公钥,\
-但反过来,一个SSH公钥只能对应于一个GitHub账号。下面的命令在\ ``~/.ssh``\ 目录\
-下创建名为\ ``gotgithub``\ 的私钥和名为\ ``gotgithub.pub``\ 的公钥文件。
+也可以用 ``ssh-keygen`` 命令以不同的名称创建多个公钥,当拥有多个GitHub账号时,非常重要。这是因为虽然一个GitHub账号允许使用多个不同的SSH公钥,但反过来,一个SSH公钥只能对应于一个GitHub账号。下面的命令在 ``~/.ssh`` 目录下创建名为 ``gotgithub`` 的私钥和名为 ``gotgithub.pub`` 的公钥文件。
::
$ ssh-keygen -C "gotgithub@gmail.com" -f ~/.ssh/gotgithub
-当生成的公钥/私钥对不在缺省位置(\ ``~/.ssh/id_rsa``\ 等)时,使用\ ``ssh``\ 命令\
-连接远程主机时需要使用参数\ ``-i 轻量级标记语言 是一种 语法简单 的标记语言。
- 它使用易于理解的格式标记,没有古怪的 World Hello
{%- if hasdoc('copyright') %}
{% trans path=pathto('copyright'), copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %}
{%- else %}
- {% trans copyright=copyright|e %}© Copyright {{ copyright }}。{% endtrans %}
+ {% trans copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %}
{%- endif %}
{%- endif %}
{%- if last_updated %}
- {% trans last_updated=last_updated|e %}最后更新于 {{ last_updated }}。{% endtrans %}
+ {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
{%- endif %}
{%- if show_sphinx %}
- {% trans sphinx_version=sphinx_version|e %}使用 Sphinx {{ sphinx_version }} 创建。{% endtrans %}
+ {% trans sphinx_version=sphinx_version|e %}Created using Sphinx {{ sphinx_version }}.{% endtrans %}
{%- endif %}
diff --git a/_theme/gotgithub/static/sphinxdoc.css b/_theme/gotgithub/static/sphinxdoc.css
index bae42cb..b80e129 100644
--- a/_theme/gotgithub/static/sphinxdoc.css
+++ b/_theme/gotgithub/static/sphinxdoc.css
@@ -148,8 +148,7 @@ a:hover {
}
div.body a {
- text-decoration: none;
- font-weight: normal;
+ text-decoration: underline;
}
h1 {
@@ -247,17 +246,6 @@ pre {
background-color: #f8f8f8;
}
-td pre {
- font-family: 'Consolas', 'Deja Vu Sans Mono',
- 'Bitstream Vera Sans Mono', monospace;
- font-size: 1em;
- letter-spacing: 0.015em;
- line-height: 120%;
- padding: 0em;
- border: 0;
- background-color: #ffffff;
-}
-
pre a {
color: inherit;
text-decoration: underline;
@@ -363,41 +351,3 @@ div.figure img {
border: 1px solid #ccc;
padding: 5px;
}
-
-.footnote-reference {
- font-size: smaller;
- line-height: 0;
- vertical-align: super;
- margin: 0;
- font-weight: normal;
-}
-
-div.body a.footnote-reference {
- text-decoration: none;
-}
-
-table.classic {
- border: 2px solid black;
- border-collapse: collapse;
- background: white;
-}
-
-table.classic td, table.docutils th {
- padding: 1px 8px 1px 5px;
- border: 1px solid black;
-}
-
-table.classic th {
- background: #aaa;
- color: white;
- border: 1px solid black;
- text-align: center;
-}
-
-.strike {
- text-decoration: line-through;
-}
-
-.underline {
- text-decoration: underline;
-}
diff --git a/_version.inc.in b/_version.inc.in
deleted file mode 100644
index f1d6dea..0000000
--- a/_version.inc.in
+++ /dev/null
@@ -1,3 +0,0 @@
-:Author: Jiang Xin
-:Version: 轻量级标记语言
-
- <标签> 。
-
-
-
-
-同样的信息如果换用轻量级标记语言来表达,就非常直观了。如下所示:
-
-::
-
- 轻量级标记语言
- ==============
-
- **轻量级标记语言** 是一种 *语法简单* 的标记语言。
- 它使用易于理解的格式标记,没有古怪的 `<标签>` 。
-
- - 可以使用最简单的文本编辑器编辑。
- - 所见即所得,非技术控亦可直接阅读源码。
- - 可版本控制。
- - 实现单一源文件出版。
-
-GitHub令人着迷的一个因素就在于GitHub为用户提供更为便捷地创建UGC\
-(用户生成内容)的方法,其奥秘就在于使用了轻量级标记语言。\
-无论是代码提交说明、提交评注、问题描述、项目的README文件、维基页面、\
-用户主页和项目主页都可以使用Markdown\ [#]_\ 等轻量级标记语言来撰写。\
-轻量级标记语言如Markdown是对人友好的标记语言,一些语法参照了\
-我们写电子邮件时的习惯,即使第一次接触用轻量级标记语言撰写的文件,也可以\
-毫无障碍地理解其中的内容。
-
-虽然GitHub更倾向于使用Markdown标记语言\ [#]_\ ,但很多地方也提供对其他轻量级\
-标记语言的支持。包括为Python程序员所熟悉的reStructedText\ [#]_\ ,为Ruby程序员\
-所熟悉的Textile\ [#]_\ 、RDoc\ [#]_\ ,为Perl程序员所熟悉的POD\ [#]_\ ,\
-为Emacs用户所熟悉的Org-mode\ [#]_\ ,为维基用户所熟悉的MediaWiki\ [#]_\ 和\
-Creole\ [#]_\ ,以及可作为DocBook\ [#]_\ 前端的颇有前途的AsciiDoc\ [#]_\ 标记语言。
-
-下面通过一张表格对几种常用的轻量级标记语言加以对照,供有不同标记语言偏好的\
-用户参考,便于在GitHub某些不能随意更换标记语言而只能使用GFM(GitHub风格的\
-Markdown)的场合可以自如地转换。
-
-在“\ :ref:`tbl-markups`\ ”中,为使表格更加紧凑使用代号表示各种标记语言。\
-例如:md为Markdown,gfm是GitHub风格的Markdown,rst为reStructedText,\
-ttl为Textile,asc为AsciiDoc,org为Org-mode。
-
-
-.. highlight:: none
-.. role:: raw-html(raw)
- :format: html
-.. role:: strike
- :class: strike
-.. role:: ul
- :class: underline
-
-.. _tbl-markups:
-
-.. table:: 表7-1:常用轻量级标记语言对照
- :class: classic
-
- +----------------------+-----------------------------+-------------------------------------------------+-----------------------------------------------+
- | | 标记语言 | | |
- | +-----+-----+-----+-----+-----+ | |
- | 类别 | MD | RST | TTL | ASC | ORG | 代码示例 | 输出示例 |
- +======================+=====+=====+=====+=====+=====+=================================================+===============================================+
- | 标题 | md | | | | | :: | |
- | | | | | | | | 输出略。 |
- | | | | | | | # 一级标题 | |
- | | | | | | | ## 二级标题 | .. note:: |
- | | | | | | | ### 三级标题 | - 标题后面可接匹配的井号。 |
- | | | | | | | #### 四级标题 | |
- | | | | | | | ##### 五级标题 | - Markdown的前两级标题还可以使用\ |
- | | | | | | | ###### 六级标题 ###### | reST风格,即在标题下衬以等号\ |
- | | | | | | | | 或减号组成的下划线。 |
- | | | | | | | | |
- | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | rst | | | | :: | |
- | | | | | | | | 输出略。 |
- | | | | | | | 一级标题 | |
- | | | | | | | ======== | .. note:: |
- | | | | | | | | - 标题级别和下划线无对应,文档中保持\ |
- | | | | | | | 二级标题 | 一致就好。 |
- | | | | | | | -------- | - reST标题可用下列符号标记: |
- | | | | | | | | # \* = - ^ ~ \` : . \ |
- | | | | | | | 三级标题 | _ + \" 等。 |
- | | | | | | | ~~~~~~~~ | |
- | | | | | | | | |
- | | | | | | | 四级标题 | |
- | | | | | | | ^^^^^^^^ | |
- | | | | | | | | |
- | | | | | | | 五级标题 | |
- | | | | | | | ++++++++ | |
- | | | | | | | | |
- | | | | | | | 六级标题 | |
- | | | | | | | ```````` | |
- | | | | | | | | |
- | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | ttl | | | :: | |
- | | | | | | | | 输出略。 |
- | | | | | | | h1. 一级标题 | |
- | | | | | | | h2. 二级标题 | |
- | | | | | | | h3. 三级标题 | |
- | | | | | | | h4. 四级标题 | |
- | | | | | | | h5. 五级标题 | |
- | | | | | | | h6. 六级标题 | |
- | | | | | | | | |
- | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | asc | | AsciiDoc 提供两种风格的标题。 | 输出略。 |
- | | | | | | | | |
- | | | | | | | - 下划线风格标题。 | |
- | | | | | | | | |
- | | | | | | | :: | |
- | | | | | | | | |
- | | | | | | | 文档标题 | .. note:: 除了两种不同风格的标题外,\ |
- | | | | | | | ======== | 还支持以点开始的块标题,\ |
- | | | | | | | | 块标题不生成目录。如: |
- | | | | | | | 一级标题 | |
- | | | | | | | -------- | :: |
- | | | | | | | | |
- | | | | | | | 二级标题 | .BlockTitle |
- | | | | | | | ~~~~~~~~ | |
- | | | | | | | | |
- | | | | | | | 三级标题 | |
- | | | | | | | ^^^^^^^^ | |
- | | | | | | | | |
- | | | | | | | 四级标题 | |
- | | | | | | | ++++++++ | |
- | | | | | | | | |
- | | | | | | | - 单行风格标题。 | |
- | | | | | | | | |
- | | | | | | | :: | |
- | | | | | | | | |
- | | | | | | | = 文档标题 = | |
- | | | | | | | == 一级标题 == | |
- | | | | | | | === 二级标题 === | |
- | | | | | | | ==== 三级标题 ==== | |
- | | | | | | | ===== 四级标题 ===== | |
- | | | | | | | | |
- | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | org | :: | |
- | | | | | | | | 输出略。 |
- | | | | | | | * 一级标题 | |
- | | | | | | | ** 二级标题 | .. note:: 为支持更多标题级别需要设置 |
- | | | | | | | *** 三级标题 | ``#+OPTIONS: H:6``\ 。 |
- | | | | | | | | |
- +----------+-----------+-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | 段落 | 空行分段 | md | rst | ttl | asc | org | :: | |
- | | | | | | | | | |
- | | | | | | | | 第一段内容。 | 第一段内容。 |
- | | | | | | | | | |
- | | | | | | | | 第二段和第一段间有一空行。 | 第二段和第一段间有一空行。 |
- | | | | | | | | | |
- | +-----------+-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | 自动续行 | md | rst | | asc | org | :: | |
- | | | | | | | | | |
- | | | | | | | | 一个回车不分段, | 一个回车不分段,°\ |
- | | | | | | | | 本行续上行。 | 本行续上行。 |
- | | | | | | | | | |
- | | | | | | | | | |
- | +-----------+-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | 不留白\ | | rst | | | | :: | |
- | | 续行 | | | | | | | |
- | | | | | | | | 行尾转义字符让\ | 行尾转义字符让\ |
- | | | | | | | | 续行之间不留白。 | 续行之间不留白。 |
- | | | | | | | | | |
- | +-----------+-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | 插入换行 | md | | | | | :: | |
- | | | | | | | | | |
- | | | | | | | | 行尾两空格°° | | 行尾两空格 |
- | | | | | | | | 保持换行。 | | 保持换行。 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | gfm | | ttl | | | :: | |
- | | | | | | | | | |
- | | | | | | | | GFM、Textile等 | | GFM、Textile等 |
- | | | | | | | | 保持段落内换行符。 | | 保持段落内换行符。 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | rst | | | | :: | |
- | | | | | | | | | |
- | | | | | | | | | 保持换行符, | | 保持换行符, |
- | | | | | | | | | 本行不续行。 | | 本行不续行。 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | rst | | | | :: | |
- | | | | | | | | | |
- | | | | | | | | .. role:: raw-html(raw) | .. role:: raw-html(raw) |
- | | | | | | | | :format: html | :format: html |
- | | | | | | | | | |
- | | | | | | | | 用新定义的role插入换行, | 用新定义的role插入换行, |
- | | | | | | | | :raw-html:`
` | :raw-html:`
` |
- | | | | | | | | 本行不再续行。 | 本行不再续行。 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | asc | | :: | |
- | | | | | | | | | |
- | | | | | | | | 行尾的空格和加号 + | | 行尾的空格和加号 |
- | | | | | | | | 保持换行。 | | 保持换行。 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | | org*| :: | |
- | | | | | | | | | |
- | | | | | | | | 行尾两个反斜线\\ | | 行尾两个反斜线 |
- | | | | | | | | 保持段落内换行符。 | | 保持段落内换行符。 |
- | | | | | | | | | |
- | +-----------+-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | 段落缩进 | md | rst | | | | :: | |
- | | | | | | | | | |
- | | | | | | | | 邮件体段落缩进: | 邮件体段落缩进: |
- | | | | | | | | | |
- | | | | | | | | > 第一级段落缩进。 | 第一级段落缩进。 |
- | | | | | | | | > | |
- | | | | | | | | > > 第二级段落缩进。 | 第二级段落缩进。 |
- | | | | | | | | > | |
- | | | | | | | | > 返回一级段落缩进。 | 返回一级段落缩进。 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | rst | | | | :: | |
- | | | | | | | | | |
- | | | | | | | | Python式段落缩进: | Python式段落缩进: |
- | | | | | | | | | |
- | | | | | | | | 第一级段落缩进。 | 第一级段落缩进。 |
- | | | | | | | | | |
- | | | | | | | | 第二级段落缩进。 | 第二级段落缩进。 |
- | | | | | | | | | |
- | | | | | | | | 返回一级段落缩进。 | 返回一级段落缩进。 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | ttl | | | :: | |
- | | | | | | | | | |
- | | | | | | | | Textile式段落缩进: | Textile式段落缩进: |
- | | | | | | | | | |
- | | | | | | | | bq. 本段缩进。 | 本段缩进。 |
- | | | | | | | | | |
- | | | | | | | | 正常段落。 | 正常段落。 |
- | | | | | | | | | |
- | | | | | | | | bq.. 注意缩进关键字后有两个点。 | 注意缩进关键字后有两个点。 |
- | | | | | | | | | |
- | | | | | | | | 后续段落持续缩进, | | 后续段落持续缩进, |
- | | | | | | | | 直至遇到 p. 定义的段落。 | | 直至遇到 p. 定义的段落。 |
- | | | | | | | | | |
- | | | | | | | | p. 正常段落不再缩进。 | 正常段落不再缩进。 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | asc | | :: | |
- | | | | | | | | | |
- | | | | | | | | 四个或以上的下划线括起的区域为引言缩进。 | 四个或以上的下划线括起的区域为引言缩进。 |
- | | | | | | | | | |
- | | | | | | | | [quote, author, source] | 引言... |
- | | | | | | | | ______________________________ | |
- | | | | | | | | 引言... | source |
- | | | | | | | | ______________________________ | |
- | | | | | | | | | —— author |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | | org | :: | |
- | | | | | | | | | |
- | | | | | | | | Org-mode式段落缩进: | Org-mode式段落缩进: |
- | | | | | | | | | |
- | | | | | | | | #+BEGIN_QUOTE | 段落缩进。 |
- | | | | | | | | 段落缩进。 | |
- | | | | | | | | #+END_QUOTE | |
- | | | | | | | | | |
- +----------+-----------+-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | 代码块 | md | | | | | :: | 四个空格缩进是代码块: |
- | | | | | | | | |
- | | | | | | | 四个空格缩进是代码块: | :: |
- | | | | | | | | |
- | | | | | | | $ printf "Hello, world.\n" | $ printf "Hello, world.\n" |
- | | | | | | | | |
- | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | gfm | | | | | :: | 三个连续的`或~等符号界定代码块。 |
- | | | | | | | | |
- | | | | | | | 三个连续的`或~等符号界定代码块。 | .. code-block:: ruby |
- | | | | | | | | |
- | | | | | | | ```ruby | require 'redcarpet' |
- | | | | | | | require 'redcarpet' | md = Redcarpet.new("Hello, world.") |
- | | | | | | | md = Redcarpet.new("Hello, world.") | puts md.to_html |
- | | | | | | | puts md.to_html | |
- | | | | | | | ``` | |
- | | | | | | | | |
- | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | rst | | | | :: | |
- | | | | | | | | |
- | | | | | | | 双冒号后缩进为代码块。 | 双冒号后缩进为代码块。 |
- | | | | | | | | |
- | | | | | | | :: | :: |
- | | | | | | | | |
- | | | | | | | $ printf "Hello, world.\n" | $ printf "Hello, world.\n" |
- | | | | | | | | |
- | | | | | | | 还可声明语言类型实现语法加亮。 | 还可声明语言类型实现语法加亮。 |
- | | | | | | | | |
- | | | | | | | .. code-block:: sh | .. code-block:: sh |
- | | | | | | | | |
- | | | | | | | $ printf "Hello, world.\n" | $ printf "Hello, world.\n" |
- | | | | | | | | |
- | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | ttl | | | :: | 以bc.或bc..指令开头的是代码块。 |
- | | | | | | | | |
- | | | | | | | 以bc.或bc..指令开头的是代码块。 | :: |
- | | | | | | | | |
- | | | | | | | bc.. $ git init | $ git init |
- | | | | | | | | |
- | | | | | | | $ git commit --allow-empty | $ git commit --allow-empty |
- | | | | | | | | |
- | | | | | | | p. 本段不再是代码块。 | 本段不再是代码块。 |
- | | | | | | | | |
- | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | ttl | | | :: | 原样格式输出,相当于标签。 |
- | | | | | | | | |
- | | | | | | | 原样格式输出,相当于
标签。 | :: |
- | | | | | | | | |
- | | | | | | | pre.. | 更上一层楼 |
- | | | | | | | 更上一层楼 | 欲穷千里目 |
- | | | | | | | 欲穷千里目 | |
- | | | | | | | | 恢复正常段落。 |
- | | | | | | | p. 恢复正常段落。 | |
- | | | | | | | | |
- | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | asc | | :: | |
- | | | | | | | | 四个或更多减号括起代码块, |
- | | | | | | | 四个或更多减号括起代码块, | 还可声明语言种类。 |
- | | | | | | | 还可声明语言种类。 | |
- | | | | | | | | .. code-block:: c |
- | | | | | | | [source, c] | |
- | | | | | | | ----------------------------- | #include
标签, | 缩进段落相当于添加
标签, |
- | | | | | | | 等宽字体,原样输出。 | 等宽字体,原样输出。 |
- | | | | | | | | |
- | | | | | | | 缩进会和其他语法如列表相混淆, | 缩进会和其他语法如列表相混淆, |
- | | | | | | | 可用 `[literal]` 显示声明。 | 可用 ``[literal]`` 显示声明。 |
- | | | | | | | | |
- | | | | | | | [literal] | :: |
- | | | | | | | 原样输出, | |
- | | | | | | | 显示为等宽字体。 | 原样输出, |
- | | | | | | | | 显示为等宽字体。 |
- | | | | | | | 或用四个以上点组成的定界符标记。 | |
- | | | | | | | | 或用四个以上点组成的定界符标记。 |
- | | | | | | | .............................. | |
- | | | | | | | 原样输出, | :: |
- | | | | | | | 显示为等宽字体。 | |
- | | | | | | | .............................. | 原样输出, |
- | | | | | | | | 显示为等宽字体。 |
- | | | | | | | | |
- | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | org | :: | 下面是代码块。 |
- | | | | | | | | |
- | | | | | | | 下面是代码块。 | .. code-block:: ruby |
- | | | | | | | | |
- | | | | | | | #+BEGIN_SRC ruby | require 'redcarpet' |
- | | | | | | | require 'redcarpet' | md = Redcarpet.new("Hello, world.") |
- | | | | | | | md = Redcarpet.new("Hello, world.") | puts md.to_html |
- | | | | | | | puts md.to_html | |
- | | | | | | | #+END_SRC | |
- | | | | | | | | |
- +----------+-----------+-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | 列表 | 无序列表 | md | rst | | | | :: | |
- | | | | | | | | | |
- | | | | | | | | * 星号、减号、加号开始列表。 | * 星号、减号、加号开始列表。 |
- | | | | | | | | | |
- | | | | | | | | - 列表层级和缩进有关。 | - 列表层级和缩进有关。 |
- | | | | | | | | | |
- | | | | | | | | + 和具体符号无关。 | + 和具体符号无关。 |
- | | | | | | | | | |
- | | | | | | | | * 返回一级列表。 | * 返回一级列表。 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | ttl | | | :: | |
- | | | | | | | | | |
- | | | | | | | | * 星号开始无序列表。 | * 星号开始无序列表。 |
- | | | | | | | | ** 更多星号代表不同层级。 | |
- | | | | | | | | *** 三级列表。 | * 更多星号代表不同层级。 |
- | | | | | | | | * 返回一级列表。 | |
- | | | | | | | | | * 三级列表。 |
- | | | | | | | | | |
- | | | | | | | | | * 返回一级列表。 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | asc | | :: | |
- | | | | | | | | | * 1个减号开始列表。 |
- | | | | | | | | - 1个减号开始列表。 | |
- | | | | | | | | * 或1到5个星号开始列表。 | - 或1到5个星号开始列表。 |
- | | | | | | | | ** 三级列表。 | |
- | | | | | | | | - 返回一级列表。 | + 三级列表。 |
- | | | | | | | | | |
- | | | | | | | | | * 返回一级列表。 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | | org | :: | |
- | | | | | | | | | |
- | | | | | | | | 列表语法和Markdown、reST类似。 | 列表语法和Markdown、reST类似。 |
- | | | | | | | | 星号和列表语法冲突需缩进,不建议使用。 | 星号和列表语法冲突需缩进,不建议使用。 |
- | | | | | | | | | |
- | | | | | | | | - 减号、加号开始列表。 | - 减号、加号开始列表。 |
- | | | | | | | | | |
- | | | | | | | | + 列表层级和缩进有关。 | + 列表层级和缩进有关。 |
- | | | | | | | | | |
- | | | | | | | | - 和具体符号无关。 | - 和具体符号无关。 |
- | | | | | | | | | |
- | | | | | | | | - 返回一级列表。 | - 返回一级列表。 |
- | | | | | | | | | |
- | +-----------+-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | 有序列表 | md | | | | | :: | |
- | | | | | | | | | |
- | | | | | | | | 1. 数字和点开始有序列表。 | 1. 数字和点开始有序列表。 |
- | | | | | | | | | |
- | | | | | | | | 1. 注意子列表的缩进位置。 | 1. 注意子列表的缩进位置。 |
- | | | | | | | | | |
- | | | | | | | | 1. 三级列表。 | 1. 三级列表。 |
- | | | | | | | | 1. 编号会自动更正。 | 2. 编号会自动更正。 |
- | | | | | | | | | |
- | | | | | | | | 1. 二级列表,编号自动更正为2。 | 2. 二级列表,编号自动更正为2。 |
- | | | | | | | | | |
- | | | | | | | | 2. 返回一级列表。 | 2. 返回一级列表。 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | rst | | | | :: | |
- | | | | | | | | | |
- | | | | | | | | 1. 数字和点是一种编号方式。 | 1. 数字和点是一种编号方式。 |
- | | | | | | | | | |
- | | | | | | | | A. 大写字母编号。 | A. 大写字母编号。 |
- | | | | | | | | | |
- | | | | | | | | a. 小写字母编号。 | a. 小写字母编号。 |
- | | | | | | | | | |
- | | | | | | | | 2. 继续一级列表。 | 2. 继续一级列表。 |
- | | | | | | | | | |
- | | | | | | | | (I) 大写罗马编号。 | (I) 大写罗马编号。 |
- | | | | | | | | | |
- | | | | | | | | i) 小写罗马编号。 | i) 小写罗马编号。 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | ttl | | | :: | |
- | | | | | | | | | |
- | | | | | | | | # 井号开始有序列表。 | 1. 井号开始有序列表。 |
- | | | | | | | | # 有序列表自动编号。 | 2. 有序列表自动编号。 |
- | | | | | | | | ## 更多井号代表不同层级。 | |
- | | | | | | | | ### 三级列表。 | 1. 更多井号代表不同层级。 |
- | | | | | | | | # 返回一级列表。 | |
- | | | | | | | | | 1. 三级列表。 |
- | | | | | | | | | |
- | | | | | | | | | 3. 返回一级列表。 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | asc | | :: | |
- | | | | | | | | | |
- | | | | | | | | 1. 和reST一样支持多种编号方式。 | 1. 和reST一样支持多种编号方式。 |
- | | | | | | | | a. 层级靠列表风格决定,而非缩进。 | |
- | | | | | | | | A. 三级列表。 | a. 层级靠列表风格决定,而非缩进。 |
- | | | | | | | | b. 返回二级列表。 | |
- | | | | | | | | i) 罗马数字列表。 | A. 三级列表。 |
- | | | | | | | | IX) 大写罗马。编号自动纠正。 | |
- | | | | | | | | 2. 返回一级列表。 | b. 返回二级列表。 |
- | | | | | | | | | |
- | | | | | | | | | i) 罗马数字列表。 |
- | | | | | | | | .. note:: 还可以用1到5个点开始有序列表, | |
- | | | | | | | | 自动按数字、字母方式编号。如: | IX) 大写罗马。编号自动纠正。 |
- | | | | | | | | | |
- | | | | | | | | :: | 2. 返回一级列表。 |
- | | | | | | | | | |
- | | | | | | | | . 数字一级列表。 | |
- | | | | | | | | .. 字母二级列表。 | |
- | | | | | | | | ... 罗马数字三级列表。 | |
- | | | | | | | | .... 大写字母四级列表。 | |
- | | | | | | | | ..... 大写罗马五级列表。 | |
- | | | | | | | | | |
- | | | | | | | | | |
- | | | | | | | | | |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | | org | :: | |
- | | | | | | | | | |
- | | | | | | | | 1. 数字和点或右括号开始有序列表。 | 1. 数字和点或右括号开始有序列表。 |
- | | | | | | | | | |
- | | | | | | | | 1) 缩进即为子列表。 | 1. 缩进即为子列表。 |
- | | | | | | | | | |
- | | | | | | | | 1. 三级列表。 | 1. 三级列表。 |
- | | | | | | | | 1. 编号会自动更正。 | 2. 编号会自动更正。 |
- | | | | | | | | | |
- | | | | | | | | 2) 二级列表。 | 2. 二级列表。 |
- | | | | | | | | | |
- | | | | | | | | 2. 返回一级列表。 | 2. 返回一级列表。 |
- | | | | | | | | | |
- | +-----------+-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | 列表续行\ | md | | | | | :: | |
- | | 、段落\ | | | | | | | |
- | | 和代码块 | | | | | | 1. 列表项可以折行, | 1. 列表项可以折行, |
- | | | | | | | | 对齐则自动续行。 | 对齐则自动续行。 |
- | | | | | | | | | |
- | | | | | | | | 2. 列表项可包含多个段落。 | 2. 列表项可包含多个段落。 |
- | | | | | | | | | |
- | | | | | | | | 空行开始的新段落必须缩进四个空格, | 空行开始的新段落必须缩进四个空格, |
- | | | | | | | | 段落才属于列表项。 | 段落才属于列表项。 |
- | | | | | | | | | |
- | | | | | | | | 3. 列表中的代码块要缩进8个空格。 | 3. 列表中的代码块要缩进8个空格。 |
- | | | | | | | | | |
- | | | | | | | | $ printf "Hello, world.\n" | :: |
- | | | | | | | | | |
- | | | | | | | | | $ printf "Hello, world.\n" |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | rst | | | | :: | |
- | | | | | | | | | |
- | | | | | | | | 1. 列表项可以折行, | 1. 列表项可以折行, |
- | | | | | | | | 对齐则自动续行。 | 对齐则自动续行。 |
- | | | | | | | | | |
- | | | | | | | | 2. 列表项可包含多个段落。 | 2. 列表项可包含多个段落。 |
- | | | | | | | | | |
- | | | | | | | | 空行开始的新段落, | 空行开始的新段落, |
- | | | | | | | | 新段落要和列表项内容对齐。 | 新段落要和列表项内容对齐。 |
- | | | | | | | | | |
- | | | | | | | | 3. 列表下的代码段注意对齐即可。 | 3. 列表下的代码段注意对齐即可。 |
- | | | | | | | | | |
- | | | | | | | | :: | :: |
- | | | | | | | | | |
- | | | | | | | | $ printf "Hello, world.\n" | $ printf "Hello, world.\n" |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | asc | | :: | |
- | | | | | | | | | |
- | | | | | | | | 1. 列表项可以折行, | 1. 列表项可以折行, |
- | | | | | | | | 对齐则自动续行。 | 对齐则自动续行。 |
- | | | | | | | | | |
- | | | | | | | | 2. 列表项可包含多个段落。 | 2. 列表项可包含多个段落。 |
- | | | | | | | | + | |
- | | | | | | | | 加号代表本段落属于列表。 | 加号代表本段落属于列表。 |
- | | | | | | | | + | |
- | | | | | | | | -- | 两个减号包裹的块作为一整体 |
- | | | | | | | | 两个减号包裹的块作为一整体 | 属于列表。 |
- | | | | | | | | 属于列表。 | |
- | | | | | | | | | 其中分段无需再使用加号。 |
- | | | | | | | | 其中分段无需再使用加号。 | |
- | | | | | | | | -- | 3. 注意列表项内代码段前空行用加号替换。 |
- | | | | | | | | | |
- | | | | | | | | 3. 注意列表项内代码段前空行用加号替换。 | :: |
- | | | | | | | | + | |
- | | | | | | | | -------- | $ printf "Hello, world.\n" |
- | | | | | | | | $ printf "Hello, world.\n" | |
- | | | | | | | | -------- | |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | | org | :: | |
- | | | | | | | | | |
- | | | | | | | | 1. 列表项可以折行, | 1. 列表项可以折行, |
- | | | | | | | | 对齐则自动续行。 | 对齐则自动续行。 |
- | | | | | | | | | |
- | | | | | | | | 2. 列表项可包含多个段落。 | 2. 列表项可包含多个段落。 |
- | | | | | | | | | |
- | | | | | | | | 空行开始的新段落, | 空行开始的新段落, |
- | | | | | | | | 新段落和列表项内容对齐即可。 | 新段落和列表项内容对齐即可。 |
- | | | | | | | | | |
- | | | | | | | | 3. 列表下的代码段注意缩进。 | 3. 列表下的代码段注意缩进。 |
- | | | | | | | | | |
- | | | | | | | | #+BEGIN_SRC bash | :: |
- | | | | | | | | $ printf "Hello, world.\n" | |
- | | | | | | | | #+END_SRC | $ printf "Hello, world.\n" |
- | | | | | | | | | |
- | +-----------+-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | 定义 | | rst | | | | :: | |
- | | | | | | | | | |
- | | | | | | | | git | git |
- | | | | | | | | Simple and beautiful. | Simple and beautiful. |
- | | | | | | | | | |
- | | | | | | | | hg | hg |
- | | | | | | | | Another DVCS. | Another DVCS. |
- | | | | | | | | | |
- | | | | | | | | subversion | subversion |
- | | | | | | | | VCS with many constrains. | VCS with many constrains. |
- | | | | | | | | | |
- | | | | | | | | Why not Git? | Why not Git? |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | ttl | | | :: | git |
- | | | | | | | | | Simple and beautiful. |
- | | | | | | | | - git := Simple and beautiful. | |
- | | | | | | | | - hg := Another DVCS. | hg |
- | | | | | | | | - subversion := | Another DVCS. |
- | | | | | | | | VCS with many constrains. | |
- | | | | | | | | | subversion |
- | | | | | | | | Why not Git? =: | VCS with many constrains. |
- | | | | | | | | | |
- | | | | | | | | | Why not Git? |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | asc | | :: | git |
- | | | | | | | | | Simple and beautiful. |
- | | | | | | | | git :: | |
- | | | | | | | | Simple and beautiful. | hg |
- | | | | | | | | hg :: Another DVCS. | Another DVCS. |
- | | | | | | | | subversion :: VCS with many constrains. | |
- | | | | | | | | + | subversion |
- | | | | | | | | Why not Git? | VCS with many constrains. |
- | | | | | | | | | |
- | | | | | | | | | Why not Git? |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | | org | :: | git |
- | | | | | | | | | Simple and beautiful. |
- | | | | | | | | - git :: Simple and beautiful. | |
- | | | | | | | | - hg :: Another DVCS. | hg |
- | | | | | | | | - subversion :: VCS with many constrains. | Another DVCS. |
- | | | | | | | | | |
- | | | | | | | | Why not Git? | subversion |
- | | | | | | | | | VCS with many constrains. |
- | | | | | | | | | |
- | | | | | | | | | Why not Git? |
- | | | | | | | | | |
- +----------+-----------+-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | 分隔线 | md | | ttl | | | :: | 输出略。 |
- | | | | | | | | |
- | | | | | | | 三条或更多短线(或星号、下划线)\ | |
- | | | | | | | 显示为分隔线。 | |
- | | | | | | | | |
- | | | | | | | --- | |
- | | | | | | | | |
- | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | rst | | | | :: | 输出略。 |
- | | | | | | | | |
- | | | | | | | 四条短线或以上显示为分隔线。 | |
- | | | | | | | | |
- | | | | | | | ---- | |
- | | | | | | | | |
- | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | asc | | :: | 输出略。 |
- | | | | | | | | |
- | | | | | | | 三个或更多的单引号作为分割线。 | |
- | | | | | | | | |
- | | | | | | | ''' | |
- | | | | | | | | |
- | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | org | :: | 输出略。 |
- | | | | | | | | |
- | | | | | | | 五条短线或以上显示为分隔线。 | |
- | | | | | | | | |
- | | | | | | | ----- | |
- | | | | | | | | |
- +----------+-----------+-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | 字体 | 粗体和\ | md | | | | | :: | |
- | | 斜体 | | | | | | | |
- | | | | | | | | 这些都是 **粗体** 或 __粗体__ , | 这些都是 **粗体** 或 **粗体** , |
- | | | | | | | | 这写都是 *斜体* 或 _斜体_ 。 | 这些都是 *斜体* 或 *斜体* 。 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | rst | | | | :: | |
- | | | | | | | | | |
- | | | | | | | | 这是 **粗体** ,这是 *斜体* 。 | 这是 **粗体** ,这是 *斜体* 。 |
- | | | | | | | | | |
- | | | | | | | | 不留白的\ **粗体**\ 和\ *斜体*\ 效果。 | 不留白的\ **粗体**\ 和\ *斜体*\ 效果。 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | ttl | | | :: | |
- | | | | | | | | | |
- | | | | | | | | 这些都是 *粗体* 或 **粗体** , | 这些都是 **粗体** 或 **粗体** , |
- | | | | | | | | 这些都是 _斜体_ 或 __斜体__ 。 | 这些都是 *斜体* 或 *斜体* 。 |
- | | | | | | | | | |
- | | | | | | | | 不留白的[*粗体*]和[_斜体_]效果。 | 不留白的\ **粗体**\ 和\ *斜体*\ 效果。 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | asc | | :: | |
- | | | | | | | | | |
- | | | | | | | | 这是 *粗体* , | 这是 **粗体** , |
- | | | | | | | | 这是 _斜体_ 或 '斜体' 。 | 这是 *斜体* 或 *斜体* 。 |
- | | | | | | | | | |
- | | | | | | | | 不留白的**粗体**和__斜体__效果。 | 不留白的\ **粗体**\ 和\ *斜体*\ 效果。 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | | org | :: | |
- | | | | | | | | | |
- | | | | | | | | 这是 *粗体* ,这是 /斜体/ 。 | 这是 **粗体** ,这是 *斜体* 。 |
- | | | | | | | | | |
- | +-----------+-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | 删除线 | gfm | | | | | :: | |
- | | | | | | | | | |
- | | | | | | | | ~~删除线~~ 效果 | :strike:`删除线` 效果 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | rst | | | | :: | |
- | | | | | | | | | |
- | | | | | | | | .. role:: strike | |
- | | | | | | | | :class: strike | |
- | | | | | | | | | |
- | | | | | | | | :strike:`删除线` 效果 | :strike:`删除线` 效果 |
- | | | | | | | | | |
- | | | | | | | | 不留白的\ :strike:`删除线`\ 效果 | 不留白的\ :strike:`删除线`\ 效果 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | ttl | | | :: | |
- | | | | | | | | | |
- | | | | | | | | -删除线- 效果 | :strike:`删除线` 效果 |
- | | | | | | | | | |
- | | | | | | | | 不留白的[-删除线-]效果 | 不留白的\ :strike:`删除线`\ 效果 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | asc | | :: | |
- | | | | | | | | | |
- | | | | | | | | [line-through]#删除线# 效果 | :strike:`删除线` 效果 |
- | | | | | | | | | |
- | | | | | | | | 不留白的[line-through]##删除线##效果 | 不留白的\ :strike:`删除线`\ 效果 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | | org | :: | |
- | | | | | | | | | |
- | | | | | | | | +删除线+ 效果 | :strike:`删除线` 效果 |
- | | | | | | | | | |
- | +-----------+-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | 下划线 | md | | | | | :: | |
- | | | | | | | | | |
- | | | | | | | | 下划线 效果 | :ul:`下划线` 效果 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | rst | | | | :: | |
- | | | | | | | | | |
- | | | | | | | | .. role:: ul | |
- | | | | | | | | :class: underline | |
- | | | | | | | | | |
- | | | | | | | | :ul:`下划线` 效果 | :ul:`下划线` 效果 |
- | | | | | | | | | |
- | | | | | | | | 不留白的\ :ul:`下划线`\ 效果 | 不留白的\ :ul:`下划线`\ 效果 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | ttl | | | :: | |
- | | | | | | | | | |
- | | | | | | | | +下划线+ 效果 | :ul:`下划线` 效果 |
- | | | | | | | | | |
- | | | | | | | | 不留白的[+下划线+]效果 | 不留白的\ :ul:`下划线`\ 效果 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | asc | | :: | |
- | | | | | | | | | |
- | | | | | | | | [underline]#下划线# 效果 | :ul:`下划线` 效果 |
- | | | | | | | | | |
- | | | | | | | | 不留白的[underline]##下划线##效果 | 不留白的\ :ul:`下划线`\ 效果 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | | org | :: | |
- | | | | | | | | | |
- | | | | | | | | _下划线_ 效果 | :ul:`下划线` 效果 |
- | | | | | | | | | |
- | +-----------+-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | 上标、\ | md | | | | | :: | |
- | | 下标 | | | | | | | |
- | | | | | | | | - Water: H2O | - Water: H\ :sub:`2`\ O |
- | | | | | | | | - E = mc2 | - E = mc\ :sup:`2` |
- | | | | | | | | | |
- | | | | | | | | | .. note:: 通过直接嵌入HTML代码实现。 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | rst | | | | :: | |
- | | | | | | | | | |
- | | | | | | | | - Water: H\ :sub:`2`\ O | - Water: H\ :sub:`2`\ O |
- | | | | | | | | - E = mc\ :sup:`2` | - E = mc\ :sup:`2` |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | ttl | | | :: | |
- | | | | | | | | | |
- | | | | | | | | - Water: H[~2~]O | - Water: H\ :sub:`2`\ O |
- | | | | | | | | - E = mc[^2^] | - E = mc\ :sup:`2` |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | asc | | :: | |
- | | | | | | | | | - Water: H\ :sub:`2`\ O |
- | | | | | | | | - Water: H~2~O | - E = mc\ :sup:`2` |
- | | | | | | | | - E = mc^2^ | |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | | org | :: | |
- | | | | | | | | | |
- | | | | | | | | - Water: H_2 O | - Water: H\ :sub:`2` O |
- | | | | | | | | - E = mc^2 | - E = mc\ :sup:`2` |
- | | | | | | | | | |
- | +-----------+-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | 等宽字体 | md | | | asc | | :: | |
- | | | | | | | | | |
- | | | | | | | | 行内反引号嵌入代码,如: `git status` 。 | 行内反引号嵌入代码,如: ``git status`` 。 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | rst | | | | :: | |
- | | | | | | | | | |
- | | | | | | | | 两个连续反引号嵌入代码,如: ``git status`` 。 | 两个连续反引号嵌入代码,如: ``git status`` 。 |
- | | | | | | | | | |
- | | | | | | | | | .. note:: 相当于 \:literal:\`git status\` 。 |
- | | | | | | | | | 只用一个反引号则相当于 \ |
- | | | | | | | | | \:title-reference:\`引言\` 。 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | ttl | | | :: | |
- | | | | | | | | | |
- | | | | | | | | 行内用字符@嵌入代码,如: @git status@ 。 | 行内用字符@嵌入代码,如: ``git status`` 。 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | asc | | :: | |
- | | | | | | | | | |
- | | | | | | | | 行内用加号或反引号标识等宽字体,如: | 行内用加号或反引号标识等宽字体,如: |
- | | | | | | | | | |
- | | | | | | | | - 命令: +git clone+ 。 | - 命令: ``git clone`` 。 |
- | | | | | | | | - 命令: `git init` 。 | - 命令: ``git init`` 。 |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | | | org | :: | |
- | | | | | | | | | |
- | | | | | | | | 行内用字符=或~嵌入代码,如: | 行内用字符=或~嵌入代码,如: |
- | | | | | | | | =git status= 和 ~git st~ 。 | ``git status`` 和 ``git st`` 。 |
- | | | | | | | | | |
- | +-----------+-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | 引言 | | rst | | | | :: | |
- | | | | | | | | | |
- | | | | | | | | `Got GitHub` by Jiang Xin. | `Got GitHub` by Jiang Xin. |
- | | | | | | | | | |
- | | +-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | | | | ttl | | | :: | |
- | | | | | | | | | |
- | | | | | | | | ??Got GitHub?? by Jiang Xin. | `Got GitHub` by Jiang Xin. |
- | | | | | | | | | |
- | +-----------+-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | 清除\ | | rst | | | | :: | |
- | | 标记空白 | | | | | | | |
- | | | | | | | | 标记符号前后空白\ | 标记符号前后空白\ |
- | | | | | | | | 用\ **反斜线**\ 消除 | 用\ **反斜线**\ 消除 |
- | | | | | | | | | |
- +----------+-----------+-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | 链接 | URL\ | gfm | rst | | asc | org | :: | |
- | | 自动链接 | | | | | | | |
- | | | | | | | | - 网址 http://github.com/ | - 网址 http://github.com/ |
- | | | | | | | | - 邮件 me@foo.bar | - 邮件 me@foo.bar |
- | | | | | | | | | |
- | +-----------+-----+-----+-----+-----+-----+-------------------------------------------------+-----------------------------------------------+
- | | 文字链接 | md | | | | | :: | |
- | | | | | | | | | - 访问 `Google