GitBook喜欢在文件名中使用连字符(-)而不是下划线(_)。
GitBook是一种基于Git的文档编辑和发布工具,用于创建漂亮的电子书和文档。在GitBook中,文件名的命名约定是使用连字符作为单词之间的分隔符,而不是下划线。这是因为在URL中,连字符是常见的分隔符,而下划线在URL中不常见。
使用连字符作为文件名的分隔符有以下优势:
推荐的腾讯云相关产品和产品介绍链接地址:
文件名称 用“-”连字符分割路径和页面关键词,例如关键词buy-men-cap中间用“-”分割关键词。...要分开,不要写在一起(buymencap),我们要让搜索引擎轻松查看各个关键字,分开时不要使用空格,不要使用下划线,使用连字符“-”。...在之前谷歌认为下划线是一个单词,谷歌虽然说修改了,但是不是真的目前还不知道。 不要将太多的关键词放到你的网址,合适就好,如果太多了,这就像向搜索引擎发送垃圾邮件,反而适得其反。...这可能并不是很重要,因为现在这种情况很常见,在实际实践中很多放弃使用文件扩展名,但是个人还是喜欢用扩展文件。...网址(URL)最佳实践 网站URL优化,GOOGLE搜索引擎优化必做优化因素,URL优化最好的实践原则: 包含关键词,但不要多,甚至文件名称也要用关键词 关键词用“-”连接符,不要使用下划线或者空格 用
/docs 目录,目录中包含以下文件: index.html:入口文件 README.md:将作为主页渲染 .nojekyll:阻止 Github Pages 忽略以下划线开头的文件 预览 使用以下命令启动本地服务器...Prism 作为代码高亮插件,可以在 index.html 中这样配置: <script src="//unpkg.com...体验对比 初次搭建这一类文档站点<em>使用</em>的是 <em>Gitbook</em>, 之前写过一篇 搭建 <em>GitBook</em> 并托管到 git pages[7],目前我仓库里可见的文档站点几乎都是 <em>Gitbook</em> 搭建的。...较好 较差 其中最大的不同点<em>还是</em> docsify 是轻量级、无需编译的,而 <em>Gitbook</em> 每次 build 都需要生成一堆 HTML 静态文件,不仅 build 时间长,还污染了我的提交记录……...♂️ 而在插件方面,虽然 docsify 插件不如 <em>Gitbook</em> 的丰富,但麻雀虽小五脏俱全,该有的基本也都有,足够<em>使用</em>。 如果再建文档站点,我估计再也不会回去<em>使用</em> <em>Gitbook</em> 了。
规则#3:应使用连字符( – )来提高 URI 的可读性 例如: http://api.example.com/blogs/guy-levin/posts/this-is-my-first-post 规则...4:不得在 URI 中使用下划线(_) 文本查看器(如浏览器,编辑器等)经常在 URI 下加下划线,以提供可点击的视觉提示。...根据应用程序的字体,下划线(_)字符可能被这个下划线部分地遮蔽或完全隐藏。...为避免这种混淆,请使用连字符( - )而不是下划线 规则5:URI 路径中首选小写字母 方便的话,URI 路径中首选小写字母,因为大写字母有时会导致问题。...规则 6:文件扩展名不应包含在 URI 中 在 Web 上,字符(.)通常用于分隔 URI 的文件名和扩展名。 一个 REST API 不应在 URI 中包含人造的文件扩展名,来表示消息实体的格式。
\w+表示字母数字下划线中的任意一个字符(\w指代的)至少出现1次,那么\w就是一个原子操作。 因此,普通字符是原子,正则中的通用字符(下面会讲到)也是原子。大家记住原子这个概念。...AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZz _]' 即匹配数字、大小写字母和下划线_字符集合中的任意一个。...你看,一个通用转义字符\w直接就指代上面这一大串,写法多么简便,同时在正则的世界里又经常被用到,故被称为:通用正则字符 类似的通用正则字符还有几个,下面也会讲到。...然而,借助于下面介绍的元字符、通用字符和捕获组合起来,便能应对解决复杂的匹配查找问题。 情况2:使用通用字符 在正则的世界里,通用字符指帮助我们更加简便的写出匹配规则的字符。...例如,在寻找手机靓号时,正则表达式66+,表示前一个原子6至少出现1次,因此连上第一个6,表示电话号码中至少有两个66紧邻。
,请使用连字符( - )字符来提高长路径中名称的可读性。...在路径中,应该使用连字符代空格连接两个单词 。...这样下划线(_)字符可能被文本查看器中默认的下划线部分地遮蔽或完全隐藏。...为避免这种混淆,请使用连字符( - )而不是下划线 规则5:URI路径中首选小写字母 方便时,URI路径中首选小写字母,因为大写字母有时会导致一些问题。...规则6:文件扩展名不应包含在URI中 在Web上,(.)字符通常用于分隔URI的文件名和扩展名。 REST API不应在URI中包含人造文件扩展名,来指示邮件实体的格式。
URI 容易被人检索和解释,请使用连字符( - )来提高长路径段中名称的可读性。...在任何你将使用英文的空格或连字号的地方,在URI中都应该使用连字符来替换。...根据应用程序的字体,下划线(_)字符可能被这个下划线部分地遮蔽或完全隐藏。...为避免这种混淆,请使用连字符( - )而不是下划线 规则#5:URI 路径中首选小写字母 方便的话,URI 路径中首选小写字母,因为大写字母有时会导致问题。...规则#6:文件扩展名不应包含在 URI 中 在 Web 上,字符(.)通常用于分隔 URI 的文件名和扩展名。 一个 REST API 不应在 URI 中包含人造的文件扩展名,来表示消息实体的格式。
第二个函数名使用了下划线法,函数名中的每一个逻辑断点都有一个下划线来标记。驼峰命名法近年来越来越流行了,在许多新的函数库和Microsoft Windows这样的环境中,它使用得当相多。...另一方面,下划线法是C出现后开始流行起来的,在许多旧的程序和UNIX这样的环境中,它的使用非常普遍。匈牙利命名法。广泛应用于象Microsoft Windows这样的环境中。...2-命名的基本原则:标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解——尽量采用采用英文单词或全部中文全拼表示,若出现英文单词和中文混合定义时,使用连字符...个人的命名风格,在符合所在项目组或产品组的命名规则的前提下,才可使用。(即命名规则中没有规定到的地方才可有个人命名风格)。...函数原型声明包括:引用外来函数及内部函数,外部引用必须在右侧注明函数来源:模块名及文件名;内部函数,只要注释其定义文件名——和调用者在同一文件中(简单程序)时不需要注释。
文件命名 文件名要全部小写, 可以包含下划线 (_) 或连字符 (-). 按项目约定来. 如果并没有项目约定,”_” 更好。...不要使用已经存在于 /usr/include 下的文件名 (Yang.Y 注: 即编译器搜索系统头文件的路径), 如 db.h....定义类时文件名一般成对出现, 如 foo_bar.h 和 foo_bar.cc, 对应于类 FooBar. 内联函数必须放在 .h 文件中. 如果内联函数比较短, 就直接放在 .h 中. 6.3....类数据成员: 不管是静态的还是非静态的,类数据成员都可以和普通变量一样, 但要接下划线。 class TableInfo { ......所有编译时常量, 无论是局部的, 全局的还是类中的, 和其他变量稍微区别一下. k 后接大写字母开头的单词: const int kDaysInAWeek = 7; 这规则适用于编译时的局部作用域常量,
在python中,私有属性可以通过__(两个下划线定),实际上一个下划线也表示私有属性,不过还是可以访问到 关于私有属性、方法——Python并没有真正的私有化支持,但可用下划线得到伪私有,所以尽量避免定义以下划线开头的变量..." 双下划线 " 开始的是私有成员,意思是只有类对象自己能访问,连子类对象也不能访问到这个数据。...反射: python面向对象中的反射:通过字符串的形式操作对象相关的属性。...python中的一切事物都是对象(都可以使用反射) 四个可以实现自省的函数 下列方法适用于类和对象(一切皆对象,类本身也是一个对象) ? ? ? 执行: m() ?...模块在导入的时候如果使用了,from module import * 那么私有方法不能被导入 ? ? ? 会报错 如果改为直接调用可以运行,这说明python没有绝对的私有机制 ? ?
在Linux,命名文件通常使用下面的字符: 小写字母,比如a, b, c … 大写字母,比如A, B, C … 数字,比如0, 1, 2 … 连字符-,不可放在文件名开头。 下划线_。 点.。...下面是几条关于文件命名的约定: 尽量不使用空格,可以使用下划线或者连字符,比如foo_bar。 重要目录尽量使用简短的名字,比如bin。 重要的文件使用大写字母命名,比如README。...如果已有文件和目标文件在同一个目录中,则为重命名操作: $ mv gamelist.txt my_gamelist.txt $ ls *gamelist.txt my_gamelist.txt 删除文件...使用-f选项将忽略文件权限和-i提示选项,因此,只有在确认自己在做什么时,才能使用-f选项。...-v选项:操作过程中显示文件提示。 -f选项:使用档名,其后不可加其他选项。 bk.tar:目标文件名。 my_bk/:操作文件名。
无论您是开发者、写作爱好者还是企业用户,Docsify都能帮助您轻松创建漂亮、易于浏览和管理的文档网站。它提供了一个现代化的界面和丰富的功能,使您能够以最小的努力构建高度可定制的文档网站。...不同于 GitBook、Hexo 的地方是它不会生成静态的 .html 文件,如果只是部署文档类的网站的话,部署这个会比部署WordPress等更为简单和省资源。...id=docsify 可以在linux,mac,Windows上来使用,今天演示用Windows作为演示,步骤都是一样的 首先确保电脑上安装了node 和npm 如果没安装的话,安装一下即可,很简单...在安装好以上2个后。...,也就是 docsify 下新建一个文件,文件名是 _coverpage.md 里面用markdown的格式进行写你想输入的介绍 以及封面图片。
下建一个文件名为 cname 的文件,写上 fxnotes.net,并随便建一个 index.html 写几个字,访问一下,是不是看到了那几个字? ...进一步地,如果我们将搭建一个博客站点,可以使用 jelly or hexo 等博客模版,然后将写好的 markdown 格式文件 push 到 xxx.github.io 某目录 下,这样就可以访问静态博客页面了...比如我们在 github 上建一个 repo WebSecurityLearning,里面分目录,且按 gitbook 的要求写一个 SUMMARY.md,包含了书目即章节结构,大致格 式如下: ?...生成书籍,需要安装下 gitbook(使用 npm 安装需要先安装 nodejs)。...无论写博客还是写文章,如果需要引用图片,需要外链,推荐用七牛云存储来上传本地图片做外链。 注:本文不涉及详细流程、设置和命令,只为大家提供个思路索引,具体动手做一遍就清晰了。
str 与js一样,python中字符串即可用单引号也可用双引号表示 numbers Python3中数值类型有:int和float两种 list 字面量表示:[1,1.0,False,'list...可以动态的给对象/类型添加属性,若给类型添加属性,则该属性在已产生的实例上也是可见的: ? 异常与错误 Python中异常与错误类间关系如下: ?...包/模块名中的连字符(-) 双下划线开头并结尾的名称(Python保留, 例如init) 命名约定 所谓”内部(Internal)”表示仅模块内可用, 或者, 在类内是保护或私有的....用单下划线(_)开头表示模块变量或函数是protected的(使用import * from时不会包含). 用双下划线(__)开头的实例变量或方法表示类内私有....对类名使用大写字母开头的单词(如CapWords, 即Pascal风格), 但是模块名应该用小写加下划线的方式(如lower_with_under.py).
它允许人们“使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档”。这种语言吸收了很多在电子邮件中已有的纯文本标记的特性。...2、什么是GitBook? GitBook 是一个基于 Node.js 的命令行工具,可使用 Github/Git 和 Markdown 来制作精美的电子书,GitBook 还是一个网站。...但是word貌似高校老师比较喜欢用,emmmm,我反正是去百度文库下模板造轮子,不高兴搞word的格式,谁爱干谁干。 4、markdown在文档写作方面的受欢迎程度是怎么样的?...以前做基于萤石云摄像头的二次开发的时候,看到它那个文档就是用gitbook + markdown生成的。 ? 逛知乎的时候看到某饥在知乎上贴的,我猜是markdown ?...gitbook的现状就是,没用被墙,但是你用它的客户端工具git book editor还是连接不上,国外嘛,懂的人自然懂,不多说。
$ gitbook init 启动 gitbook 项目 启动本地服务,程序无报错则可以在浏览器预览电子书效果: http://localhost:4000 由于能够实时预览电子书效果...,并且大多数开发环境搭建在本地而不是远程服务器中,所以主要用于开发调试阶段..._book 是默认的输出目录,存放着原始 markdown 渲染完毕后的 html 文件,可以直接打包到服务器充当静态网站使用.一般是执行 gitbook build 或 gitbook serve 自动生成的...|配置项|描述| |-|-| |structure.readme|readme 文件名(默认值是 README.md)| |structure.summary|summary 文件名(默认值是 SUMMARY.md...)| |structure.glossary|glossary 文件名(默认值是 GLOSSARY.md)| |structure.languages|languages 文件名(默认值是 LANGS.md
[gitbook-openwrite-office.png] 还是熟悉的 markdown 编辑器,便捷的自动认证功能,发布文章再也不用一处编辑,到处复制了,顺便解决了一直令人困扰的图片上传问题....安装 openwrite 插件 在 book.json 配置文件中,添加 openwrite 插件到 plugins 数组中,示例如下: { "plugins" : ["openwrite"]...本来打算直接修改 gitbook 模板文件,但是独乐乐不如众乐乐,所以还是采用插件的方式扩展吧!...上一步构建目标区域时设置了 id="vip-container" ,在这一步直接使用了该区域唯一标示,所以该配置项不必暴露给外部用户,因此配置项中没有 id ....总结寄语 总体来说,OpenWrite 作为一文多发平台是非常优秀的,对于多平台发布的小伙伴来说简直就是福音,但是假如你并没有一文多发的需求,那可能对你的帮助并不是很大,因为连复制粘贴都不需要了啊!
但这个编码规范不仅关于编码风格,还包括 WordPress 生态中互操作性、可翻译性和安全性等方面的最佳实践,因此即使使用其他的编码风格 ,还是建议开发者在最佳实践方面仍然遵守 WordPress 编码标准...在正则表达式中使用单引号字符串是最简便的,因为相比双引号,单引号字符串只有两个元序列需要转移:\' 和 \\。...命名约定 在变量名,action/filter 的名称和函数名使用小写,不要使用驼峰式,通过下划线分割单词, 如非必需不要使用缩写,让代码无歧义并能自我说明: function some_name( $...] } class WP_HTTP { [...] } 常量必须全部大写,并用下划线分割: define( 'DOING_AJAX', true ); 文件名应使用小写字母进行描述性命名,使用连字符应分隔...: my-plugin-name.php 类文件名应该基于类名,然后在前面加上 class-,然后类名中的下划线替换为连字符,例如 WP_Error 的文件名: class-wp-error.php 在
二、变量的类型 程序中: 在 Python 里为了应对不同的业务需求,也把数据分为不同的类型。...如下图所示: 三、查看数据类型 在python中,只要定义了一个变量,而且它有数据,那么它的类型就已经确定了,不需要咱们开发者主动的去说明它的类型,系统会自动辨别。...命名规则 标识符由字母、下划线和数字组成,且数字不能开头。 严格区分大小写。 不能使用关键字。...思考:下面的标识符哪些是正确的,哪些不正确为什么 fromNo12 (正确) from#12 (错误,不能使用特殊字符) my_Boolean (正确) my-Boolean (错误,不能使用连字符)...Python的命令规则遵循PEP8标准: 变量名,函数名和文件名全小写,使用下划线连接; 类名遵守大驼峰命名法; 常量名全大写; 关键字 关键字的概念一些具有特殊功能的标识符,这就是所谓的关键字
前言 大家好,我是Kuls,这次的前言还是我来写。Go系列的文章是我的好朋友琨哥来编写,主要针对的就是学习GO语言的朋友。...整个系列难度适合新手入门级别,当然也会有一些实战的案例,如果你喜欢这个系列,可以来个一键三连~ 第一个Go程序 Go语言是静态语言,强类型语言 我的第一个go-demo package main import...>//函数 -- func main() >//语句 & 表达式 >//注释 执行Go程序: 1、直接goland中运行 2、在命令行中使用==go run hello.go== 3、还能使用==...6. ) 行分隔符 在 Go 程序中,一行代表一个语句结束。每个语句不需要像 C 家族中的其它语言一样以分号 ; 结尾,因为这些工作都将由 Go 编译器自动完成。...一个标识符实际上就是一个或是多个字母(A~Z和a~z)数字(0~9)、下划线_组成的序列,但是第一个字符必须是字母或下划线而不能是数字。
Vue 驱动 享受 Vue + webpack 的开发体验,可以在 Markdown 中使用 Vue 组件,又可以使用 Vue 来开发自定义主题。.../css/gittalk.css'; 使用评论组件 理论上,我们在每个 markdown 文件里直接加入这个组件即可,但是每次都添加有点麻烦,还是让 node 来帮我们吧 根目录创建...VuePress 的配置成本稍稍大一点,不过可以使用 Vue 的语法与组件,定制化更自由一点,而且 VuePress 中编写 Vue 和平时一样,学习成本几乎为零,可以本地用 VsCode 编辑,然后直接命令行部署...非技术人员推荐用 GitBook,技术人员推荐用 VuePress,特别是前端技术人员。 个人更喜欢 VuePress 。 4....,还是用回了 功能很重的 wordpress。 因为非技术人员要用起来的话,学习成本是比较大的 ?
领取专属 10元无门槛券
手把手带您无忧上云