readme.md 语法

1.标题

  1.1大标题

    标题

    ===

  12.中标题

    标题

    -------

  1.3.标题

    #一级标题

    ##二级标题

    ###三级标题

    ####四级标题

    #####五级标题

    ######六级标题

2.文本

  1单行文本

    使用两个Tab符实现单行文本。

  2多行文本

    多行文本和单行文本异曲同工,只要在每行行首加两个Tab

  3高亮

    `text`

  4超链接

    1文字超链接

      要显示的文字 ]( 链接的地址 )

    2鼠标悬停显示的文本

      要显示的文字 ]( 链接的地址  "悬停显示")

3.插入符号

  圆点符

    要注意的是星号* 后面要有一个空格。否则显示为普通星号

    此外还有二级圆点和三级圆点。就是多加一个Tab

4.缩进

  >数据结构

  >>树

  >>>二叉树

  >>>>平衡二叉树

  >>>>>满二叉树

5.插入图片

  ![](http://www.baidu.com/img/bdlogo.gif)

  图片超链接

    [![baidu]](http://baidu.com)

    [baidu]:http://www.baidu.com/img/bdlogo.gif "百度Logo"

6.插入代码片段

  我们需要在代码的上一行和下一行用` `` 标记。``` 不是三个单引号,而是数字1左边,Tab键上面的键。要实现语法高亮那么只要在 ``` 之后加上你的编程语言即可

时间: 2024-10-25 20:34:30

readme.md 语法的相关文章

Markdown语法学习(Github/git.oschina.net上README.md书写规范)(转)

晚上在更新git.oschina.net项目时,突然想知道README.md后缀的来源,于是搜了下,发现README.md使用了一种小标记语言Markdown的语法,于是简单的看了一个,特转载如下,为了下次参考方便(http://blog.csdn.net/kaitiren/article/details/38513715也不错).中文参考手册可以参考http://wowubuntu.com/markdown/index.html Markdown 的目标是实现「易读易写」,兼容HTML. 但是

Markdown语法(例如:github的readme.md)

大标题 =================================== 大标题一般显示工程名,类似html的\<h1\><br /> 你只要在标题下面跟上=====即可 中标题 ----------------------------------- 中标题一般显示重点项,类似html的\<h2\><br /> 你只要在标题下面输入------即可 ### 小标题 小标题类似html的\<h3\><br /> 小标题的格式如下

github的README.md的markdown语法

1.标题表示法:#是一级标题,二个#是二级标题,以此类推.支持六级标题. 注意:#与标题名中间的空格 # 一级标题 ## 二级标题 ### 三级标题 #### 四级标题 ##### 五级标题 ###### 六级标题 2.换行: 建议直接在前一行后面补两个空格. 3.字体: *强调* (示例:斜体) _强调_ (示例:斜体) **加重强调** (示例:粗体) __加重强调__ (示例:粗体) ***特别强调*** (示例:粗斜体) ___特别强调___ (示例:粗斜体) 总结: 斜体:要倾斜的文字

GitHub上README.md教程

转自:http://blog.csdn.net/kaitiren/article/details/38513715#t0 最近对它的README.md文件颇为感兴趣.便写下这贴,帮助更多的还不会编写README文件的同学们. README文件后缀名为md.md是markdown的缩写,markdown是一种编辑博客的语言.用惯了可视化的博客编辑器(比如CSDN博客,囧),这种编程式的博客编辑方案着实让人眼前一亮.不过GitHub支持的语法在标准markdown语法的基础上做了修改,称为Githu

关于github中的README.md文件

0x01 README.md文件是用Markdown语言编写的,md=Markdown; 在线编辑工具: https://stackedit.io/editor# https://maxiang.io/#笔记本和标签 关于使用语法的说明: https://github.com/guoyunsky/Markdown-Chinese-Demo 0x02 Markdown 是一种轻量级的「标记语言」,它的优点很多,目前也被越来越多的写作爱好者,撰稿者广泛使用.看到这里请不要被「标记」.「语言」所迷惑,

原来Github上的README.md文件这么有意思——Markdown语言详解

转载请注明出处:http://blog.csdn.net/zhaokaiqiang1992 之前一直在使用github,也在上面分享了不少的项目和Demo,每次创建新项目的时候,使用的都是默认的README.md文件,也不曾对这个文件有 过什么了解.但是在看到别人写的项目的README.md里面竟然有图片.链接什么的,就感到很好奇,这效果是什么加上去的?于是便查了一下资料,结果, 竟迁出了一门从来没有了解过的语言— —Markdown! github上的README.md文件就是使用的Markd

[转]GitHub上README.md教程

本文转载于CSDN,原博客地址:http://blog.csdn.net/kaitiren/article/details/38513715 最近对它的README.md文件颇为感兴趣.便写下这贴,帮助更多的还不会编写README文件的同学们. README文件后缀名为md.md是markdown的缩写,markdown是一种编辑博客的语言.用惯了可视化的博客编辑器(比如CSDN博客,囧),这种编程式的博客编辑方案着实让人眼前一亮.不过GitHub支持的语法在标准markdown语法的基础上做了

(转)为项目编写Readme.MD文件

转自http://www.coderli.com/write-readme-for-your-project/ 了解一个项目,恐怕首先都是通过其Readme文件了解信息.如果你以为Readme文件都是随便写写的那你就错了.github,oschina git gitcafe的代码托管平台上的项目的Readme.MD文件都是有其特有的语法的.称之为Markdown语法.基本规则如下: Markdown 语法速查表1 标题与文字格式标题# 这是 H1 <一级标题>## 这是 H2 <二级标题

Github中的README.md使用的标记语言---Markdown语言

github上的README.md文件就是使用的Markdown语言编写的.它是一种易读易写的标记语言. 1.来龙去脉和语法特点 Markdown 是一种轻量级标记语言,创始人为约翰·格鲁伯(John Gruber).它允许人们"使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档".这种语言吸收了很多在电子邮件中已有的纯文本标记的特性. Markdown 的目标是实现「易读易写」.可读性,无论如何,都是最重要的.一份使用 Markdown 格式撰写的文件应