Markdown 编写规范

说明 文档中使用的关键字「MUST」,「MUST NOT」,「REQUIRED」,「SHALL」,「SHALL NOT」,「SHOULD」,「SHOULD NOT」,「RECOMMENDED」,「MAY」和「OPTIONAL」在 RFC2119 中有说明。 还未定稿,对规范中提及的点有不赞同的欢迎提出 issues(请添加 markdown 标签)讨论。 规则 后缀必须「MUST」使用 .md。 文件名必须「MUST」使用小写,多个单词之间使用-分隔。 文件编码必须「MUST」用 UTF-8。 文档标题应该「SHOULD」这样写。 Markdown 编写规范 ========================== 章节标题必须「MUST」以 ## 开始,而不是 #。 章节标题必须「MUST」在 # 后加一个空格,且后面没有 #。 // bad ##章节1 // bad ## 章节1 ## // good ## 章节1 章节标题和内容间必须「MUST」有一个空行。 // bad ## 章节1 内容 ## 章节2 // good ## 章节1 内容 ## 章节2 代码段的必须「MUST」使用 Fenced code blocks 风格,如下所示: ``` console.log(""); ``` 表格的写法应该「SHOULD」参考 GFM,如下所示: First Header | Second Header ------------- | ------------- Content Cell | Content Cell Content Cell | Content Cell | Left-Aligned | Center Aligned | Right Aligned | | :------------ |:---------------:| -----:| | col 3 is | some wordy text | $1600 | | col 2 is | centered | $12 | | zebra stripes | are neat | $1 | 中英文混排应该「SHOULD」采用如下规则:...

September 24, 2024 · 2 min · 223 words · Similarityoung

Git 约定式提交(Conventional Commits)

文档连接 语义化版本: 用于发版相关的规范 约定式提交(Conventional Commits)是一种用于写作提交消息的规范,它规定了一套标准化的提交消息格式,以使得项目的版本控制更加清晰和一致。采用这种规范的好处是能够帮助开发团队更好地理解代码的变更历史、生成变更日志(changelog),以及进行版本控制。 约定式提交的基本格式 <类型>(<范围>): <描述> <主体> <footer> 各部分说明 1. 类型(type):用于说明提交的类型,例如是修复bug还是添加新功能。常见的类型包括: feat:新功能(feature) fix:修补bug docs:文档(documentation)变更 style:代码格式(不影响代码运行的变动) - refactor:重构(即不是新增功能,也不是修改bug的代码变动) - test:增加测试 - chore:构建过程或辅助工具的变动 2. 范围(scope):可选项,用于说明提交影响的范围(例如模块、文件等)。 3. 描述(subject):简要说明提交的内容。 4. 主体(body):可选项,用于详细说明提交的内容,可以分成多行。 5. 脚注(footer):可选项,用于说明重大变更,或者关联的issue。例如: - BREAKING CHANGE:说明重大变更 - Closes #123:关闭issue 示例 feat(auth): add login functionality Added login functionality with OAuth2 integration. Users can now log in using their Google account. Closes #45

September 17, 2024 · 1 min · 59 words · Similarityoung

go 学习笔记

go 学习路线 GoLang语法新奇 golang 中的表达式,加";“与不加都可以,建议不加 另外函数方法中的{},符合 java 中的标准,需要放在函数名后面 变量声明 package main import "fmt" /* 四种变量声明方式 */ var x, y int var ( //这种分解的写法,一般用于声明全局变量 a int b bool ) func main() { //声明变量 默认为 0 var a int fmt.Println("a = ", a) // 方法二 声明变量,并初始化 var b int = 100 fmt.Println("b = ", b) //方法三 (不推荐) 初始化省去数据类型,通过值来自动匹配数据类型 var c = 100 fmt.Println("c = ", c) // 方法四:(最常用的方法),只能用在函数体内 e := 100 fmt.Println("e = ", e) fmt....

August 29, 2024 · 8 min · 1602 words · Similarityoung

JavaScript

JavaScript 教程 在 HTML 中,JavaScript 代码必须位于标签之间。 能够在 HTML 文档中放置任意数量的脚本。 脚本可被放置与 HTML 页面的 <body> 或 <head> 部分中,或兼而有之。 <script src="myScript.js"></script> 注意是 src是引用 js 的方式。 通过 const 定义的变量与 let 变量类似,但==不能重新赋值。== 模板字面量_提供了一种将变量和表达式插入字符串的简单方法–${...} 箭头函数 hello = () => { return "Hello World!"; } 模块(modules) 导出 JavaScript 模块允许您将代码分解成单独的文件。 这会使维护代码库更加容易。 模块是使用 import 语句从外部文件导入的。 模块还依赖于 < script > 标签中的 type="module"。 <script type="module"> import message from "./message.js"; </script> 命名导出(Named Exports) 让我们创建一个名为 person.js 的文件,并在其中填充我们要导出的内容。 您可以通过两种方式创建命名导出。一种是逐个内联创建,另一种是在文件底部一次性全部创建。 逐个内联创建: person.js export const name = "Bill"; export const age = 19; 在文件底部一次性创建:...

August 7, 2024 · 6 min · 1137 words · Similarityoung

CSS

字体属性的说明 (1)网页中不是所有字体都能用,因为这个字体要看用户的电脑里面装没装,比如你设置: font-family: "华文彩云"; 上方代码中,如果用户的 Windows 电脑里面没有这个字体,那么就会变成宋体。 页面中,中文我们一般使用:微软雅黑、宋体、黑体。英文使用:Arial、Times New Roman。页面中如果需要其他的字体,就需要单独安装字体,或者切图。 (2)为了防止用户电脑里,没有微软雅黑这个字体。就要用英语的逗号,提供备选字体。如下:(可以备选多个) font-family: "微软雅黑","宋体"; 上方代码表示:如果用户电脑里没有安装微软雅黑字体,那么就是宋体。 (3)我们须将英语字体放在最前面,这样所有的中文,就不能匹配英语字体,就自动的变为后面的中文字体: font-family: "Times New Roman","微软雅黑","宋体"; 上方代码的意思是,英文会采用Times New Roman字体,而中文会采用微软雅黑字体(因为美国人设计的Times New Roman字体并不针对中文,所以中文会采用后面的微软雅黑)。比如说,对于smyhvae哈哈哈这段文字,smyhvae会采用Times New Roman字体,而哈哈哈会采用微软雅黑字体。 CSS 整体感知 我们先来看一段简单的 css 代码: <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8" /> <title>Document</title> <style> p { color: red; font-size: 30px; text-decoration: underline; font-weight: bold; text-align: center; font-style: italic; } h1 { color: blue; font-size: 50px; font-weight: bold; background-color: pink; } </style> </head> <body> <h1>我是大标题</h1> <p>我是内容</p> </body> </html> 解释如下:...

July 1, 2024 · 2 min · 312 words · Similarityoung