reStructuredText是一种reStructuredText是一种轻量级的文本标记语言,简单易读,所见即所得的文本标记语言。 其一般保存的文件以.rst为后缀。...段落 段落是reST文档中最基础的部分,段落通过一个或者多个空行分隔开。左侧必须对齐(没有空格,或者有相同多的空格)。 内联标记 标准的reST内联标记包括:粗体、斜体以及引用。...大写字母 i) 小写罗马数字 (I) 大写罗马数字 列表前后, 以及条目之间必须有空行隔开. 列表下面可以插入任意的内容, 段落, 图片都可以, 只要他们的左侧和列表的第一个文字左对齐。...及上划线表示部分 * 及上划线表示章节 =, 小章节 -, 子章节 ^, 子章节的子章节 ", 段落 显示标记 显式标用在那些需做特殊处理的reST结构中, 如尾注,突出段落,评论,通用指令....显式标记以 .. 开始,后跟空白符,与下面段落的缩进一样. (在显示标记与正常的段落间需有空行,这听起来有些复杂,但是写起来会非常直观.) 指令 指令是显式标记最常用的模块。
reStructuredText是什么 它是一个类似于MarkDown的标记语言,具体可参考这里:http://zh.wikipedia.org/wiki/ReStructuredText, 手册在这里...sphinx-doc-zh.readthedocs.org/en/latest/rest.html 下面用几个例子来说明这个东西怎么用 章节 # 有上标线, 用以部分 * 有上标线, 用以章节 = 用以小节 - 用以子节 ^ 用以子节的子节..." 用以段落 段落 用空行隔开就自动识别为一个段落 链接 效果: Link text test code: `Link text `_ 上面的代码放到内容中的需要前后空格
应该将 h1 用作 唯一 的主标题(最重要的),其后是 h2(次重要的),再其次是 h3,以此类推。 段落 段落元素用于定义文本的段落结构,使文本更有组织和可读性。...它会在上下内容前后各添加一个换行,将文本分组成独立的部分,使得段落之间有明显的区分。段落元素主要包括 标签,它表示一个段落。 示例: 这是一个段落。 这是另一个段落。... 效果: HTML 文档中可存在若干段落 浏览器会自动地在段落的前后添加空行 不要忘记结束标签(即使忘了结束标签,大多数浏览器也会正常显示) 如果不喜欢段落元素添加的上下文空行,想缩小行距,请使用...默认情况下,链接将以以下形式出现在浏览器中: 一个未访问过的链接显示为蓝色字体并带有下划线。 访问过的链接显示为紫色并带有下划线。 点击链接时,链接显示为红色并带有下划线。...高亮 元素用于标记文本中的一部分,以便突出显示或标记这部分文本。通常,被 元素标记的文本会以黄色背景进行突出显示,以使其在文档中更为显眼。
与 之间的文本被显示为段落 HTML 元素 HTML 文档是由 HTML 元素定义的。...注释:浏览器会自动地在标题的前后添加空行。 注释:默认情况下,HTML 会自动地在块级元素前后添加一个额外的空行,比如段落、标题元素前后。...( 是块级元素) 提示:使用空的段落标记 去插入一个空行是个坏习惯。用 标签代替它!(但是不要用 标签去创建列表。...AThis is a paragraph B使用空的段落标记 去插入一个空行 CThis is a paragraph 5.下列折行标签使用正确的是?...A可以通过在 HTML 代码中添加额外的空格或换行来改变输出的效果 B使用标签来折行 C使用空的段落标记 去插入一个空行是个好习惯
Markdown 语法受到一些既有 text-to-HTML 格式的影响,包括 Setext、atx、Textile、reStructuredText、Grutatext 和 EtText,而最大灵感来源其实是纯文本电子邮件的格式...区块元素 段落和换行 一个 Markdown 段落是由一个或多个连续的文本行组成,它的前后要有一个以上的空行(空行的定义是显示上看起来像是空的,便会被视为空行。...比方说,若某一行只包含空格和制表符,则该行也会被视为空行)。普通段落不该用空格或制表符来缩进。...的确,需要多费点事(多加空格)来产生 ,但是简单地「每个换行都转换为 」的方法在 Markdown 中并不适合, Markdown 中 email 式的 区块引用 和多段落的 列表 在使用换行来排版的时候...使用 Markdown 的参考式链接,可以让文件更像是浏览器最后产生的结果,让你可以把一些标记相关的元数据移到段落文字之外,你就可以增加链接而不让文章的阅读感觉被打断。
---- 区块元素 段落和换行 一个 Markdown 段落是由一个或多个连续的文本行组成,它的前后要有一个以上的空行(空行的定义是显示上看起来像是空的,便会被视为空行。...比方说,若某一行只包含空格和制表符,则该行也会被视为空行)。普通段落不该用空格或制表符来缩进。...的确,需要多费点事(多加空格)来产生 ,但是简单地「每个换行都转换为 」的方法在 Markdown 中并不适合, Markdown 中 email 式的 区块引用 和多段落的...然后接着定义链接: [Daring Fireball]: http://daringfireball.net/ 链接的定义可以放在文件中的任何一个地方,我比较偏好直接放在链接出现段落的后面,你也可以把它放在文件最后面...使用 Markdown 的参考式链接,可以让文件更像是浏览器最后产生的结果,让你可以把一些标记相关的元数据移到段落文字之外,你就可以增加链接而不让文章的阅读感觉被打断。
Markdown 语法受到一些既有 text-to-HTML 格式的影响,包括 Setext、atx、Textile、reStructuredText、Grutatext 和 EtText,而最大灵感来源其实是纯文本电子邮件的格式...Markdown 的区块引用看起来就真的像是引用一段文字,就像你曾在电子邮件中见过的那样。...它的语法种类很少,只对应 HTML 标记的一小部分。Markdown 的构想不是要使得 HTML 文档更容易书写。在我看来, HTML 已经很容易写了。...要制约的只有一些 HTML 区块元素――比如 、、、 等标签,必须在前后加上空行与其它内容区隔开,还要求它们的开始标签与结尾标签不能用制表符或空格来缩进。...HTML 的区段(行内)标签如 、、 可以在 Markdown 的段落、列表或是标题里随意使用。
## 第一印象 AsciiDoc 基本语法跟 Markdown 类似,例如以 = 号开头作为标题、以 * 号开头作为列表项、以空行分割段落等,下面是一段 AsciiDoc 文本: =...Markdown 通过自行扩展语法或者使用 HTML 可以实现这些格式,但前者造成文档不通用的问题,后者则直接把展示结构硬编码到了文档中,将来修改会很麻烦。...AsciiDoctor 是一个很宏伟的项目,还有很多子项目在开发中,例如我比较关注的 Asciidoctor PDF 和 Asciidoctor EPUB3,这两个项目用于去掉现有工具链中对 DocBook...## 编辑器 轻量级标记语言不依赖编辑器,但好的编辑器会让写作过程更愉快。...* reStructuredText:基本上是 Python 开发者在用。 * 其他类似。 综合功能、易用性、社区氛围、配套工具来看,目前我觉得 AsciiDoc 最好。
1、注释 1.1、块注释 “#”号后空一格,段落件用空行分开(同样需要“#”号) # 块注释 # 块注释 # # 块注释 # 块注释 1.2、行注释 至少使用两个空格和语句分开,注意不要使用无意义的注释...# 正确的写法 x = x + 1 # 边框加粗一个像素 # 不推荐的写法(无意义的注释) x = x + 1 # x加1 1.3、建议 在代码的关键部分(或比较复杂的地方), 能写注释的要尽量写注释...一般出现在模块头部、函数和类的头部,这样在python中可以通过对象的__doc__对象获取文档....Sections support any reStructuredText formatting, including literal blocks:: $ python example_google.py...# 正确的写法 def function(a, b): """计算并返回a到b范围内数据的平均值""" ... ...
文档即代码:即把文档的编写和 git 代码托管相一致 方便的组织结构:利用工具能很好的组织文档的结构 风格统一:风格不统一,最后项目维护起来存在巨大的沟通成本 这种文档的组织方式核心是使用了 reStructuredText...标记语言编写文档。...尝试从下面几个步骤讲解文档如何编写: reStructuredText 对比 markdown markdown 同样也是在程序员圈子里比较受欢迎的标记语言,大大减轻了编写文档的难度,reStructuredText...经过这样的思考便于朝着目标学习核心的语法点。 我的思考结果如下: 标题 段落 文本标记 图片 表格 链接 上述6个部分几乎包括一篇的全部组成,所以学习 rst 语法也从这6个部分着手。...在 SUMMARY.md 文件中构造目录结构 比如创建两个章节: # Summary ## one * [Introduction](README.md) * [Chapter1](chapter1
区块元素 段落和换行 一个 Markdown 段落是由一个或多个连续的文本行组成,它的前后要有一个以上的空行(空行的定义是显示上看起来像是空的,便会被视为空行。...比方说,若某一行只包含空格和制表符,则该行也会被视为空行)。普通段落不该用空格或制表符来缩进。...的确,需要多费点事(多加空格)来产生 ,但是简单地「每个换行都转换为 」的方法在 Markdown 中并不适合, Markdown 中 email 式的 区块引用 和多段落的...使用 Markdown 的参考式链接,可以让文件更像是浏览器最后产生的结果,让你可以把一些标记相关的元数据移到段落文字之外,你就可以增加链接而不让文章的阅读感觉被打断。...图片 很明显地,要在纯文字应用中设计一个「自然」的语法来插入图片是有一定难度的。 Markdown 使用一种和链接很相似的语法来标记图片,同样也允许两种样式: 行内式和 参考式。
程序需要能够处理不同文本块(如标题、段落和列表项)以及内嵌文本(如突出的文本和URL)。 虽然这个实现添加的是HTML标签,但应该很容易对其进行扩展,以支持其他标记语言。...---- 4.初次实现 首先要做的事情之一是将文本分成段落。段落之间有一个或多个空行。比段落更准确的说法是块(block),因为块也可以指标题和列表项。...4.1.找出文本块 要找出这些文本块,一种简单的方法是,收集空行前的所有行并将它们返回,然后重复这样的操作。不需要收集空行,因此不需要返回空文本块(即多个空行)。...我将这些代码存储在文件util.py中,这意味着你稍后可在程序中导入这些生成器。 4.2.添加一些标记 使用这些基本功能,可创建简单的标记脚本。为此,可按如下基本步骤进行。...(1)打印一些起始标记。 (2)对于文本块,在段落标签内打印它。 (3)打印一些结束标记。 这不太难,但用处也不大。这里假设要将第一个文本块放在一级标题标签(h1)内,而不是段落标签内。
最近在整理党小组会议记录的时候,由于使用了腾讯会议的自动会议纪要功能 腾讯会议yyds 在导出会议纪要文件的时候,都会带有"(时间)",甚至是后面的"***",显然我在后续整理会议记录的时候这些东西都得处理掉...会议记录令人头秃 按照传统方法,一个一个删除掉,那我两个小时的会议记录得删到啥时候?...这个时候,word的替换功能就牛起来啦 我之前常常用word的替换功能去删除掉文档中多余的空格、空行等,这次也打算试试!...删除括号及其中内容 在使用Linux进行操作时,经常会用到通配符"*",通配符顾名思义代表任何字符,如在linux环境下使用rm *.sh命令即代表删除所有以”.sh"结尾命名的文件,我们发现在word...删除空格 在查找内容输入空格,替换部分什么也不输入即可 删除空行 删除空行只需要找到你的两段文档是通过什么换行符换行的,下面我采用了常用的段落标记进行演示 还不快去试试手!
---- HTML 段落 ---- HTML 可以将文档分割为若干段落。 ---- HTML 段落 段落是通过 标签定义的。 实例 ? ? 注意:浏览器会自动地在段落的前后添加空行。...屏幕的大小,以及对窗口的调整都可能导致不同的结果。 对于 HTML,您无法通过在 HTML 代码中添加额外的空格或换行来改变输出的效果。 当显示页面时,浏览器会移除源代码中多余的空格和空行。...所有连续的空格或空行都会被算作一个空格。需要注意的是,HTML 代码中的所有连续的空行(换行)也被显示为一个空格。 ? ?...在标签 中使用了href属性来描述链接的地址。 默认情况下,链接将以以下形式出现在浏览器中: 一个未访问过的链接显示为蓝色字体并带有下划线。 访问过的链接显示为紫色并带有下划线。...---- HTML 链接- id 属性 id属性可用于创建在一个HTML文档书签标记。 提示: 书签是不以任何特殊的方式显示,在HTML文档中是不显示的,所以对于读者来说是隐藏的。
文档字符串 (docstring) 使用三个双引号"""......""" 2.4、空行 模块级函数和类定义之间空两行; 类成员函数之间空一行; class A: def __init__(self...): pass def hello(self): pass def main(): pass 可以使用多个空行分隔多组相关的函数 函数中可以使用空行分隔出逻辑相关的代码...import Bar import语句应该放在文件头部,置于模块说明及docstring之后,于全局变量之前; import语句应该按照顺序排列,每组之间用一个空行分隔 import os import...plotz says to frobnicate the bizbaz first. """ """Oneline docstring""" 二、注释 1、注释 1.1、块注释 “#”号后空一格,段落件用空行分开...一般出现在模块头部、函数和类的头部,这样在python中可以通过对象的doc对象获取文档.
段落的前后要有空行,所谓的空行是指没有文字内容。...若想在段内强制换行的方式是使用两个以上空格加上回车(引用中换行省略回车)。...printf("Hello, Markdown."); } 注意:需要和普通段落之间存在空行。...若不在引用区块中,必须和前方段落之间存在空行。 效果: 第一项 第二项 第三项 有序列表的标记方式是将上述的符号换成数字,并辅以.,如: 1 . 第一项 2 . 第二项 3 ....库1 注意:上述的[1]:https:://github.com/younghz/Markdown "Markdown"不出现在区块中。
下面是Markdown的介绍。 image.png 长期以来,我都认为我在GitLab和GitHub上看到的所有带有.md扩展名的文件都是专门为开发人员编写的文件类型。...来自维基百科的温馨提示: Markdown是一种轻量级的标记语言,具有纯文本格式语法。 这对你来说意味着,通过在文本中使用一些额外的符号,Markdown 可以帮助你创建一个具有明确结构的文档。...确保在段落之间放置一个空行。 如果你习惯于写商务信函或传统的散文,那么这可能会让你觉得不自然,因为段落中只有一行空行,甚至可能在第一个单词之前有一个缩进。...对 Markdown 来说,一个空行(某些文字处理器用¶标记,称为Pilcrow符号)可以保证在将新段落转换为HTML之类的另一种格式时格式不出错。 4. 指定标题和副标题。...要插入链接请将您要链接的文本放在方括号中,并将URL放在括号中,并且之间没有空格:[Markdown教程] image.png 8.
HTML 段落 可以把 HTML 文档分割为若干段落,段落是通过 标签定义的。...如下代码: This is a paragraph This is another paragraph 注释:浏览器会自动地在段落的前后添加空行。...( 是块级元素) 提示:使用空的段落标记 去插入一个空行是个坏习惯。用 标签代替它!(但是不要用 标签去创建列表。...屏幕的大小,以及对窗口的调整都可能导致不同的结果。 对于 HTML,您无法通过在 HTML 代码中添加额外的空格或换行来改变输出的效果。 当显示页面时,浏览器会移除源代码中多余的空格和空行。...所有连续的空格或空行都会被算作一个空格。需要注意的是,HTML 代码中的所有连续的空行(换行)也被显示为一个空格。
文章中的每个词语都带有词性标记。...一篇文章里面的段落之间是不空行的,在两篇文章之间,会有一个空行,表示文章的分界线,同时,下一篇文章的“篇章号-段号”都会有所改变。 标号之后,是2个单字节空格,然后开始正文。...正文部分按照规范已经切分成词,并且加上标注,标注的格式为“词语/词性”,即词语后面加单斜线,再紧跟词性标记。词与词之间用2个单字节空格隔开。每段最后的词,在标记之后也有2个单字节空格,保持格式一致。...语料中除了词性标记以外,还有“短语标记”,这种情况一般出现在机构团体名称、成语等情况中。.../w 4.生语料库和熟语料库 语料库中存放的是在语言的实际使用中真实出现过的语言材料,语料库是以电子计算机为载体承载语言知识的基础资源,真实语料需要经过加工
markdown 是一种标记语言,我这个博客就是用markdown格式写好后,由hexo框架将markdown格式转换为静态的HTML文件,再上传到网站服务器上。...在使用markdown的时候,有的时候在使用有序列表的时候,总会出现一些与预期效果不符的情况。...有序下标中,有多个段落,则下标以及每个段落的开头都必须缩进4个空格或1个制表符 how are you today? I am fine. Good Morning! Good Morning!...下标中的表示代码段的3个撇号不用缩进 int main() { return 0; } 不同下标间不用空行,否则也会出错 表示代码结束的三个`后面不能加空格,否则后面的内容也会被当作代码段的。...在GitHub网站上,有序列表的不同下标之间需要隔一个空行,否则渲染会出问题 参考:http://wowubuntu.com/markdown/
领取专属 10元无门槛券
手把手带您无忧上云