README

这篇具有很好参考价值的文章主要介绍了README。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

一、Markdown

简介

Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档。

应用

当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如:GitHub、简书、知乎等

编辑器

推荐使用Typora,官网:https://typora.io/

二、徽章

什么是徽章

徽章是一种小巧精美的小图标,一般配有相关文字进行辅助说明,可对数据进行监控,链接跳转等,富有表现力。

常见于github项目主页,但其不仅出现于 github 项目主页,凡是能够表现图片的地方都可以出现徽章。

徽章的使用
  • markdown中使用
格式: [![图片文字说明](图片源地址)](超链接地址)  即超链接内部嵌套图片
语法:
[![github](https://image.baidu.com/search/detail?ct=503316480&z=0&ipn=d&word=java%20%E5%9B%BE%E7%89%87&hs=0&pn=1&spn=0&di=7249025186345779201&pi=0&rn=1&tn=baiduimagedetail&is=0%2C0&ie=utf-8&oe=utf-8&cl=2&lm=-1&cs=3573756467%2C3701343599&os=2120908530%2C2874681224&simid=4200407873%2C731464050&adpicid=0&lpn=0&ln=30&fr=ala&fm=&sme=&cg=&bdtype=0&oriquery=java%20%E5%9B%BE%E7%89%87&objurl=https%3A%2F%2Fi0.hdslb.com%2Fbfs%2Farchive%2F457bb110086fac07b665762c00ff4247de3ad039.jpg&fromurl=ippr_z2C%24qAzdH3FAzdH3Ffiw6j_z%26e3Bkdn_z%26e3BpeAzdH3Fwennmb99mlAzdH3F8&gsm=&islist=&querylist=&dyTabStr=MTEsMCwzLDYsNCwxLDUsMiw4LDcsOQ%3D%3D)

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

徽章生成网站:https://shields.io/

本文档主要介绍markdown,不对徽章做过多介绍,详细介绍请 戳我 访问。

三、设置目录

设置之后会根据分级标题来自动生成目录。

语法:
@[toc]

注:github暂未支持。


在github生成TOC的方法: https://github.com/ekalinin/github-markdown-toc

windows系统需要基于golang实现的工具:https://github.com/ekalinin/github-markdown-toc.go

如果你有GO语言的编译环境,可以尝试自己编译,如果没有,可以直接下载编译好的二进制文件。

如windows系统64位 下载:gh-md-toc.windows.amd64.tgz (386 是32位,amd64是64位)

下载解压后,发现没有后缀名无法识别,实际上这是个exe文件,所以只需要暴力地在后面加上.exe就可以开始愉快使用了。

使用方法:

  1. 首先将.md文档复制到gh-md-toc.exe的根目录下
  2. 在该目录下打开系统命令行,输入命令:gh-md-toc.exe README.MD 生成目录
  3. 把生成的目录复制到.md文件即可。

这是gh-md-toc生成的目录:

  • 一、Markdown
    • 简介
    • 应用
    • 编辑器
  • 二、徽章
    • 什么是徽章
    • 徽章的使用
  • 三、设置目录
  • 四、标题
  • 一级标题
    • 二级标题
      • 三级标题
        • 四级标题
          • 五级标题
            • 六级标题
    • 五、文本
      • 段落
      • 字体
      • 删除线
      • 下划线
      • 文字高亮
      • 分隔线
      • 脚注
    • 六、列表
      • 无序列表
      • 有序列表
      • 折叠列表
      • 带复选框列表
      • 列表嵌套
    • 七、区块引用
      • 区块嵌套
      • 区块中使用列表
      • 列表中使用区块
    • 八、代码
      • 代码区块
    • 九、链接
      • 变量链接
      • Github中使用内部链接
      • 锚点链接
    • 十、图片
      • 图片宽高
      • 相对路径以及Github中使用图片
    • 十一、表格
    • 十二、Emoji表情包
    • 十三、其他技巧
      • 支持的 HTML 元素
      • 转义
      • 数学公式
      • 图表
      • 流程图
      • 时序图
      • 甘特图

四、标题

语法:
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

一级标题

二级标题

三级标题

四级标题
五级标题
六级标题

五、文本

段落

Markdown 段落没有特殊的格式,直接编写文字,需要段落缩进时使用2个Tab

字体

语法:
*斜体文本* 
或 _斜体文本_
**粗体文本**
或  __粗体文本__
***粗斜体文本***
或 ___粗斜体文本___

斜体文本

斜体文本

粗体文本

粗体文本

粗斜体文本

粗斜体文本

删除线

如果段落上的文字要添加删除线,只需要在文字的两端加上两个波浪线 ~~ 即可,实例如下:

语法:
~~BAIDU.COM~~

BAIDU.COM

下划线

下划线可以通过 HTML 的 标签来实现:

语法:
<u>带下划线的文本</u>

注:github暂未支持。

带下划线的文本

文字高亮

文字高亮功能能使行内部分文字高亮,使用一对反引号。

语法:
`html` `css` `javascript` 

html css javascript

分隔线

你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:

语法:
***

*****

- - -

----------

脚注

脚注是对文本的补充说明。

语法:
[^变量]
在文档结尾或其他位置給变量赋值:
[^变量]: 注明框内显示的内容

鼠标移到这里> [^哈喽]
[^哈喽]: 注明框内显示的内容

注:github暂未支持。

鼠标移到这里> 1

六、列表

无序列表

使用星号()、加号(+)或是减号(-*)作为列表标记:

语法:
* 第一项
* 第二项

+ 第一项
+ 第二项

- 第一项
- 第二项
  • 第一项
  • 第二项

有序列表

使用数字并加上 . 号来表示

语法:
1. 第一项
2. 第二项
  1. 第一项
  2. 第二项

折叠列表

语法:
<details>
<summary>点我打开关闭折叠</summary>
 折叠内容
 <ul>
     <li>1</li>
     <li>2</li>
     <li>3</li>
 </ul>
</details>

注意:<details> 标签内写markdown代码无效,可写html代码,如ul>li、table等

点我打开关闭折叠 折叠内容
  • 1
  • 2
  • 3
包含table的折叠
分类 例词
人称代词-主格 I我,you你,he他,she她,they他们, we我们
人称代词-宾格 me我, you你, him他, her她, them他们, us我们
物主代词 my我的, his他的, your你的(your你们的), their他们的, hers她的
指示代词 this这, that那, these这些, those 那些
反身代词 myself我自己, himself他自己, themselves他们自己, yourself你(们)自己,herself她自己
疑问代词 who谁, what什么, which哪个
不定代词 some一些, many许多, both两个、两个都, any许多
关系代词 which……的物, who……的人, that……的人或物, who谁, that引导定语从句
相互代词 each other 互相, one another互相
连接代词 who,whom,whose,what,which,whatever,whichever,whoever,whomever
替代词 one(单数),ones(复数)

带复选框列表

语法:
* [x] 第一项
* [ ] 第二项
* [ ] 第三项
  • 第一项

  • 第二项

  • 第三项

列表嵌套

语法:
1. 第一项:
    - 第一项嵌套的第一个元素
    - 第一项嵌套的第二个元素
2. 第二项:
    - 第二项嵌套的第一个元素
    - 第二项嵌套的第一个元素
  1. 第一项
    • 嵌套1
    • 嵌套2
  2. 第二项
    • 嵌套1
      • 嵌套2

七、区块引用

区块引用是在段落开头使用 > 符号 ,然后后面紧跟一个空格符号:

语法:
> 区块引用

区块引用

回车键自动延伸区块

区块嵌套
语法:
> 第一层
> > 第二层
> > > 第三层

第一层

第二层

第三层

区块中使用列表
语法:
> 区块中使用列表
> 1. 第一项
> 2. 第二项
> * 111
> * 222

区块中使用列表

  1. 第一项
  2. 第二项
    • 111
    • 222
列表中使用区块
语法:
* 第一项
    > 区块
* 第二项
  • 第一项

    区块

    区块

  • 第二项

八、代码

如果是段落上的一个函数或片段的代码可以用反引号把它包起来(`):

语法:
`function()` 函数

function()函数

代码区块

``` 包裹一段代码,并指定一种语言(也可以不指定):

本代码区块为说明:

语法:
​```javascript
function test() {
	alert('test')
}
​```

效果:

function test() {
	alert('test')
}

九、链接

语法:
[链接名称](链接地址)

[链接名称](链接地址,可选的alt)

或

<链接地址>

例如:

语法:
[百度](http://www.baidu.com,'百度')

百度

直接显示链接地址:

语法:
<http://www.baidu.com>

http://www.baidu.com

变量链接

语法:
链接可以用变量来代替,文档末尾或其他位置附带变量地址:
这个链接用 1 作为网址变量 [Google][1]
这个链接用 baidu 作为网址变量 [Baidu][baidu]
然后在文档的结尾为变量赋值(网址)

  [1]: http://www.google.com/
  [baidu]: http://www.baidu.com/

Google

Baidu

Github中使用内部链接

语法:
可使用相对路径(前提是有该路径下的文件)
[test](test.md)

test

锚点链接

本文件中每一个标题都是一个锚点,和HTML的锚点(#)类似

语法:
[Markdown](#Markdown)

注: github对含有标点符号的标题进行锚点时会忽略掉标点符号,
本页中,如果这样写则无法跳转:[链接](#九、链接)
正确写法:[链接](#九链接)

Markdown

链接

流程图

十、图片

语法:
![alt替代文本](图片地址)

![alt替代文本](图片地址 "title标题")
  • 开头一个感叹号 !

  • 接着一个方括号,里面放上图片的替代文字

  • 接着一个普通括号,里面放上图片的地址,最后还可以用引号包住并加上选择性的 ‘title’ 属性的文字。

语法:
![logo](./test/logo.png "logo")

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

当然,你也可以像链接那样对图片地址使用变量:

这里链接用 img 作为图片地址变量 
然后在文档的结尾或其他位置给变量赋值(图片地址)
语法:
![RUNOOB][img]
[img]: ./test/logo.png

图片宽高

如下想设置图片宽高,可以使用 标签。

语法:
<img src="./test/logo.png" width="50px" height="30px">

相对路径以及Github中使用图片

不管是在本地还是在github同一个仓库中,如果图片存在,可以使用相对路径。github上如果引用其他github仓库中的图片则要注意地址格式,即:仓库地址/raw/分支名/图片路径

相对路径图片:

语法:
![头像图片](./test/test.jpg)

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

其他仓库的图片:

语法:
![其他仓库的图片](https://github.com/xugaoyi/vue-music/raw/master/src/common/image/default.png)

README,应用工具,编辑器

十一、表格

制作表格使用 (|) 来分隔不同的单元格,使用( -) 来分隔表头和其他行。

语法:
|  表头   | 表头  |
|  ----  | ----  |
| 单元格  | 单元格 |
| 单元格  | 单元格 |
表头 表头
单元格 单元格
单元格 单元格

对齐方式

  • -: 设置内容和标题栏居右对齐
  • :- 设置内容和标题栏居左对齐
  • :-: 设置内容和标题栏居中对齐
语法:
| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |
左对齐 右对齐 居中对齐
单元格 单元格 单元格
单元格 单元格 单元格

十二、Emoji表情包

语法:  Emoji表情英文名的前后加冒号,Typore上先输入冒号再输入首字母有表情提示
如:
:smirk:

💋
😸🙈🐴
😏😊😃😄 ☀️

更多表情名称请查看:表情包清单

十三、其他技巧

支持的 HTML 元素

不在 Markdown 语法涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。

目前支持的 HTML 元素有:<kbd> <b> <i> <em> <sup> <sub> <br>等 ,如:

语法:
使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑

使用 Ctrl+Alt+Del 重启电脑

使用b标签的加粗字体

转义

Markdown 使用了很多特殊符号来表示特定的意义,如果需要显示特定的符号则需要使用反斜杠转义字符:

语法:
**未转义星号显示加粗** 
\*\* 转义显示星号 \*\*

未转义星号显示加粗
** 转义显示星号 **

Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

\   反斜线
`   反引号
*   星号
_   下划线
{}  花括号
[]  方括号
()  小括号
#   井字号
+   加号
-   减号
.   英文句点
!   感叹号

*** 以下部分在Github暂未支持 ***


数学公式

当你需要在编辑器中插入数学公式时,可以使用两个美元符 $$ 包裹 TeX 或 LaTeX 格式的数学公式来实现。提交后,问答和文章页会根据需要加载 Mathjax 对数学公式进行渲染。如:

语法:
$$
\mathbf{V}_1 \times \mathbf{V}_2 =  \begin{vmatrix} 
\mathbf{i} & \mathbf{j} & \mathbf{k} \\
\frac{\partial X}{\partial u} &  \frac{\partial Y}{\partial u} & 0 \\
\frac{\partial X}{\partial v} &  \frac{\partial Y}{\partial v} & 0 \\
\end{vmatrix}
$$tep1}{\style{visibility:hidden}{(x+1)(x+1)}}
$$

V 1 × V 2 = ∣ i j k ∂ X ∂ u ∂ Y ∂ u 0 ∂ X ∂ v ∂ Y ∂ v 0 ∣ \mathbf{V}_1 \times \mathbf{V}_2 = \begin{vmatrix} \mathbf{i} & \mathbf{j} & \mathbf{k} \\ \frac{\partial X}{\partial u} & \frac{\partial Y}{\partial u} & 0 \\ \frac{\partial X}{\partial v} & \frac{\partial Y}{\partial v} & 0 \\ \end{vmatrix} V1×V2= iuXvXjuYvYk00

图表

语法:
​```chart
,Budget,Income,Expenses,Debt
June,5000,8000,4000,6000
July,3000,1000,4000,3000
Aug,5000,7000,6000,3000
Sep,7000,2000,3000,1000
Oct,6000,5000,4000,2000
Nov,4000,3000,5000,

type: pie
title: Monthly Revenue
x.title: Amount
y.title: Month
y.suffix: $
​```
​```mermaid
sequenceDiagram
A->>B: 是否已收到消息?
B-->>A: 已收到消息
​```

注:在Typora中未支持

,Budget,Income,Expenses,Debt
June,5000,8000,4000,6000
July,3000,1000,4000,3000
Aug,5000,7000,6000,3000
Sep,7000,2000,3000,1000
Oct,6000,5000,4000,2000
Nov,4000,3000,5000,

type: pie
title: Monthly Revenue
x.title: Amount
y.title: Month
y.suffix: $

流程图

语法:
​```mermaid
graph TD
A[模块A] -->|A1| B(模块B)
B --> C{判断条件C}
C -->|条件C1| D[模块D]
C -->|条件C2| E[模块E]
C -->|条件C3| F[模块F]
​```

流程图相关文章:https://www.jianshu.com/p/b421cc723da5

http://www.imooc.com/article/292708

时序图

语法:
​```mermaid
sequenceDiagram
A->>B: 是否已收到消息?
B-->>A: 已收到消息
​```

甘特图

语法:
​```mermaid
gantt
title 甘特图
dateFormat  YYYY-MM-DD
section 项目A
任务1           :a1, 2018-06-06, 30d
任务2     :after a1  , 20d
section 项目B
任务3      :2018-06-12  , 12d
任务4      : 24d
​```

​ 回到顶部


  1. 注明框内显示的内容 ↩︎文章来源地址https://www.toymoban.com/news/detail-698951.html

到了这里,关于README的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • Unity 编辑器工具之批量设置图片压缩

    一个简单的工具,对Unity下的图片做批量压缩处理,主要有以下功能: 自动取消 \\\"Generte Mip Maps\\\" 勾选; 针对文件夹批量自动(或手动选择压缩格式)设置图片压缩并自动保存; 单个图片文件的压缩设置; 使用方法,右键单张图片(或者包含图片的文件夹) 会打开一个设置窗口 如下,窗口里会

    2024年02月10日
    浏览(48)
  • Linux文本处理工具sed(流编辑器)

    sed是一种流编辑器,它一次处理一行内容。 处理时,把当前处理的行存储在临时缓冲区(模式空间)中,接着用sed命令处理缓冲区中的内容,处理完成后,把缓冲区的内容送到屏幕。接着处理下一行,这样不断重复直到文件末尾。 文件内容并没有改变 ,除非你使用重定向存

    2024年02月12日
    浏览(66)
  • 【Unity UIToolkit】UIBuilder基础教程-制作简易的对话系统编辑器 3步教你玩转Unity编辑器扩展工具

    随着Unity开发的深入,基本的Unity编辑器界面并不能满足大部分玩家高阶开发的要求。为了提高开发的效率,有针对性的定制化扩展编辑器界面是提高开发效率的不错选择。 今天就给大家带来Unity官方提高的编辑器扩展工具UIToolkit(集成了UIBuilder和UI Debugger等插件)的使用教程。

    2024年02月04日
    浏览(72)
  • Linux基础工具|文本编辑器Vim的使用

    您好这里是limou3434的个人博客,感兴趣可以看看我的其他内容。 本次我给您带来的是Linux下Vim文本编辑器的使用,关于vim,您只需要知道一些常用的指令和操作即可,快速上手的秘诀是实践,并且是多次实践。 安装:在centos环境下安装vim可以使用“sudo yum install vim”,其他环

    2024年02月11日
    浏览(50)
  • 【Linux环境基础开发工具】编辑器-vim

    vim是一个编辑器,是在Linux下编程的常用工具,如果要学习在Linux下的编程, 那学会使用vim是一个必修课,今天我就来讲解如何使用vim编辑器。 目录 写在前面 什么是vim vim的常用命令 (1)gg:定位光标到第一行第一个位置 (2)shift + g:定位光标到最后一行 (3)n + shift + g:

    2024年02月07日
    浏览(54)
  • 前端必备的开发工具推荐——VScode代码编辑器

            VSCode(全称:Visual Studio Code)是一款由微软开发且跨平台的免费源代码编辑器。该软件支持语法高亮、代码自动补全(又称 IntelliSense)、代码重构、查看定义功能,并且内置了命令行工具和 Git 版本控制系统。用户可以更改主题和键盘快捷方式实现个性化设置,也

    2024年02月02日
    浏览(61)
  • Linux:Vim文本编辑器及其应用详解

    众多 Linux 发行版系统,通常都已经默认安装好了 vi 或 Vim 文本编辑器,Centos 也不例外,该系统就默认安装有 vi 文本编辑器,但建议大家使用 Vim。 如果在命令行模式下输入“vim”,输出结果为“Command not found”,则表示此系统中未安装 Vim。 CentOS 系统中,使用如下命令即可安

    2024年02月12日
    浏览(74)
  • 图形编辑器开发:最基础但却复杂的选择工具

    大家好,我是前端西瓜哥。 对于一个图形设计软件,它最基础的工具是什么? 选择工具 。 但这个选择工具,却是相当的复杂。这次我来和各位,细说细说选择工具的一些弯弯道道。 我正在开发的图形设计工具的: https://github.com/F-star/suika 线上体验: https://blog.fstars.wang/ap

    2024年02月09日
    浏览(69)
  • Unity UGUI一键绑定UI控件工具(编辑器拓展)

    全为一键生成 实现自动生成代码绑定UI控件 并生成字典保存UI控件 减少自己拖拽 和手动书写过程 适用动态加载面板 建议搭配UI框架使用 根据当前选中的gameobject 查找其下方是否有对应类型的控件 有就保存到字典中 然后通过向上递归拼凑地址,然后生成到粘贴板 直接粘贴到目

    2024年04月23日
    浏览(62)
  • Unity 编辑器预制体工具类PrefabUtility 常用函数和用法

    在Unity中,预制体(Prefab)是一种非常有用的工具,它允许我们创建可重复使用的对象和场景元素。Unity提供了许多内置的工具和函数来处理预制体,其中一个重要的类就是PrefabUtility。PrefabUtility类提供了一系列函数,用于创建、实例化和管理预制体。在本文中,我们将介绍

    2024年02月14日
    浏览(45)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包