`

GitHub中的README.MD文件编写语法

阅读更多

GitHub中的README文件,使用markdown格式的文件。这种文件语法比较简单,特别容易上手。

Markdown的语法简洁明了、学习容易,而且功能比纯文本更强,因此有很多人用它写博客。世界上最流行的博客平台WordPress和大型CMS如joomladrupal都能很好的支持Markdown。

下面简单介绍下相关语法:

大标题:

===================================

大标题一般显示工程名,你只要在标题下面跟上=====即可(“=”个数无限制)

中标题

———————————-

中标题一般显示重点项,你只要在标题下面输入——即可(“-”个数无限制)

小标题:

小标题的格式如下 ### 小标题,注意#和标题字符中间要有空格

也可以使用1到6个“#”来表示六级标题:

# 这是 H1

## 这是 H2

###### 这是 H6

斜体:

可以使用* 或 _ 包围文字,例如*Hello World*

加粗:

用两个 * 或 _ 包起来的话,达到加粗字体的左右,例如**Hello Markdown**

如果你的 * 和 _ 两边都有空白的话,它们就只会被当成普通的符号

单行文本框:

只要两个Tab再输入文字即可

多行文本框:

你可以写入代码等,每行文字只要输入两个Tab再输入文字即可

引用:

引用是使用类似 email 中用 > 的引用方式,例如:> 文字被些字符包围开始,可以在每行上加上“<”,也可以只在首行加上“<”能够达到一样的效果。区块引用可以嵌套(例如:引用内的引用),只要根据层次加上不同数量的 > :

> 这是第一层引用。

>

> > 这是嵌套的引用块。

>

> 回到第一层。

列表:

无序列表使用星号、加号或是减号作为列表标记,例如:*Red、+Green、-Blue

有序列表则使用数字接着一个英文句点,例如:1.hello;注意,你在列表标记上使用的数字并不会影响输出的 HTML 结果,你可以使用1. Bird 1. McHale 1. Parish甚至6.ADC 3.EFG 9.XYZ 都可以实现正确的有序列表显示。

超链接:

Markdown 支持两种形式的链接语法: 行内式和参考式两种形式。

不管是哪一种,链接文字都是用 [方括号] 来标记;要建立一个行内式的链接,只要在方块括号后面紧接着圆括号并插入网址链接即可,如果你还想要加上链接的 title 文字,只要在网址后面,用双引号把 title 文字包起来即可,例如:[This link](http://example.net/) has no title attribute

如果你是要链接到同样主机的资源,你可以使用相对路径:See my [About](/about/) page for details

参考式的链接是在链接文字的括号后面再接上另一个方括号,而在第二个方括号里面要填入用以辨识链接的标记:This is [an example][id] reference-style link

接着,在文件的任意处,你可以把这个标记的链接内容定义出来:[id]: http://example.com/ "Optional Title Here"

图片:

图片的语法和超链接非常相似。只显示图片:![github](http://example.com/unicorn.png “github”);点击图片进入另一个网页:[![image]](http://www.example.com/) [image]: http://example.com/example.png “example

分享到:
评论

相关推荐

    开源的readme.md编写工具

    **开源的README.md编写工具** 在软件开发领域,README文件是项目的重要组成部分,它提供了项目的概述、安装指南、使用说明以及贡献方式等信息。随着Markdown的流行,许多开发者选择使用Markdown格式来编写README,...

    从Readmemd文件创建美观简单的HTML页面

    Markdown(Readme.md)是一种轻量级的标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成结构化的HTML(超文本标记语言)页面。这个过程在软件开发、文档撰写、博客发布等领域非常常见。本教程将...

    ReadMe-Generator:我使用简单的NodeJS应用程序来构建readme.md文件

    2. **Markdown语法**:`readme.md`文件使用Markdown语言编写,学习基本的Markdown语法,如标题、段落、列表、链接、代码块等,能有效地组织和格式化文本。 3. **命令行工具开发**:了解如何在Node.js中创建可执行的...

    modhelp-在终端中着色显示README.md的模块

    标题中的“modhelp”是一个模块,它专门设计用于在终端中以着色的方式显示README.md文件。这个模块的目的是为了提升在终端环境下阅读Markdown格式文档的体验,尤其是那些包含代码块、强调文本和链接的README文件。...

    README.md-Generator

    在"README.md-Generator"中,用户通过交互式界面输入项目信息,这些信息会被格式化成Markdown语法,方便在GitHub等平台上展示。例如,# 用于创建一级标题,`code`用于代码块,* 或 - 用于无序列表等。 **项目结构与...

    markdown-cheatsheet:Github的Markdown备忘单Readme.md

    这个标题表明资源是关于GitHub上使用的Markdown语法的快速参考指南,特别是针对`Readme.md`文件的编写。`Readme.md`是GitHub项目页面上默认显示的文档,通常用于介绍项目的目的、安装指南、使用方法等。 **描述** ...

    markgreene74:您发现了一个秘密! markgreene74markgreene74是一个:sparkles:special:sparkles:存储库,可用于将README.md添加到GitHub个人资料

    标签是“Python”,这告诉我们这个存储库可能涉及到Python编程语言,或许包含了一些利用Python编写的脚本或工具,这些可能用于自动生成、管理和更新个人资料的`README.md`文件。 至于压缩包内的文件“markgreene74-...

    README.md

    2. **Git与GitHub**:在IT行业中,`README.md`文件经常与Git版本控制系统和GitHub托管平台关联。GitHub鼓励用户在其仓库首页包含一个`README.md`,以便其他人了解项目的用途、安装指南、使用方法、许可信息等。 3. ...

    使用markdown文件生成github文件夹的VSCode扩展

    在GitHub上,Markdown被广泛用于编写README、LICENSE等文件,使得代码仓库的文档更加清晰易懂。而Visual Studio Code(VSCode)是一款强大的源代码编辑器,支持多种编程语言,并且拥有丰富的扩展功能。 标题提到的...

    emoueitchaien:您发现了一个秘密! emoueitchaienemoueitchaien是一个:sparkles:specialthat存储库,可用于将README.md添加到您的GitHub个人资料中。 确保它是公共的,并使用自述文件将其初始化以开始使用

    标题中的“emoueitchaien”是一个与GitHub个人资料装饰相关的项目,它允许用户在他们的GitHub个人资料中添加一个自定义的`README.md`文件,以展示更丰富的信息或个性化设计。这个仓库是一个特别的资源,用户可以利用...

    frankyoung89_github_io-源码.rar

    7. **Markdown语法**: `README.md`文件通常用Markdown编写,这是一种轻量级的标记语言,用于编写清晰易读的文档。了解Markdown的基本语法是理解项目的重要一环。 8. **项目部署**: 通过GitHub Actions或者手动操作...

    Typora编辑工具

    2. **通用性**:Markdown文件可以跨平台阅读和编辑,被广泛应用于博客、GitHub、GitLab等平台。 3. **可读性强**:Markdown代码结构清晰,即使未经排版,预览效果也相对整洁。 4. **易于转换**:Markdown文件可以...

    rithik-c:我的GitHub个人资料的配置文件

    3. **Markdown语法**: `README.md`文件使用Markdown语言编写,可以包含文本、代码片段、链接、图像和emoji,以创建丰富的格式化内容。 4. **自定义CSS**: 如果用户希望更个性化的展示,可以通过创建`profile.css`...

    repo-github

    标题“repo-github”暗示了这...总结起来,"repo-github"涉及了GitHub的仓库管理、readme.md文件的编写和编辑、版本控制的使用以及协作开发的基本流程。这些都是在GitHub上进行开源软件开发或项目协作的重要组成部分。

    open_Windows_terminal

    “README.md”文件通常用Markdown语法编写,这是一种轻量级的标记语言,用于格式化文本。如果用户没有Markdown阅读器,可以用任何支持Markdown的浏览器打开,如Chrome、Firefox等,直接查看文件内容。README文件通常...

    md文件打开器.zip

    在GitHub上,Markdown文件常用于编写项目README、问题描述、wiki页面等,因此一个好的Markdown编辑器是开发者必备的工具之一。 总的来说,"md文件打开器.zip"提供的软件可以帮助用户更轻松地处理Markdown文件,无论...

    html_github_io-源码.rar

    7. **其他文件**:如README.md,提供关于项目的说明;或者LICENSE文件,声明开源许可证等。 在学习和分析这个源码时,你可以关注以下知识点: 1. **HTML语法规则**:了解如何使用HTML标签创建网页结构,如头部、...

    README.md:1. Visual Studio代码

    VS Code支持与GitHub、Azure DevOps等源代码托管平台的无缝对接,你可以直接在编辑器中创建和管理Pull Request,参与代码审查,进行协作开发。 **7. 多语言支持** VS Code不仅支持多种编程语言,还支持多语言的用户...

    olash515:我的GitHub个人资料的配置文件

    6. **GitHub Profile badges**: 在`README.md`文件中,常见的是各种成就徽章,它们可以显示项目的状态(如持续集成/持续部署的结果)、许可证类型、编程语言使用比例等。这些徽章通常是通过将特定的SVG图像URL插入到...

    FarhanRah:我的GitHub个人资料的配置文件

    这个配置文件通常被称为 `README.md` 文件,它使用 Markdown 语法编写,允许用户以一种简洁、易读的形式展示信息。在 FarhanRah 的个人资料中,我们可以挖掘出以下几个关键知识点: 1. **Markdown 语法**: ...

Global site tag (gtag.js) - Google Analytics