Github Readme 使用markdown语言总结

作者: Jalynn葸 | 来源:发表于2016-12-26 16:56 被阅读171次

github传完代码,为了让读者迅速知道你代码的功能活着结构,你得填写一个ReadMe,

但是,按常规格式写的readme文件会不分段,全部压在一行,也不能传图片等。

度娘告诉我需要用markdown语言,这是一种类似html的语言课简单的页面分层布局。下面是我的readme文件和常用的标记符号;

大标题

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

大标题一般显示工程名,类似html的\

你只要在标题下面跟上=====即可

中标题

-----------------------------------

中标题一般显示重点项,类似html的\

你只要在标题下面输入------即可

### 小标题

小标题类似html的\

小标题的格式如下 ### 小标题

注意#和标题字符中间要有空格

### 注意!!!下面所有语法的提示我都先用小标题提醒了!!!

### 单行文本框

这是一个单行的文本框,只要两个Tab再输入文字即可

### 多行文本框

这是一个有多行的文本框

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

这里你可以输入一段代码

### 比如我们可以在多行文本框里输入一段代码,来一个Java版本的HelloWorld吧

public class HelloWorld {

/**

* @param args

*/

public static void main(String[] args) {

System.out.println("HelloWorld!");

}

}

### 链接

1.[点击这里你可以链接到www.google.com](http://www.google.com)

2.[点击这里我你可以链接到我的博客](http://guoyunsky.iteye.com)

###只是显示图片

![github](http://github.com/unicorn.png"github")

###想点击某个图片进入一个网页,比如我想点击github的icorn然后再进入www.github.com

[![image]](http://www.github.com/)

[image]: http://github.com/github.png"github"

### 文字被些字符包围

> 文字被些字符包围

>

> 只要再文字前面加上>空格即可

>

> 如果你要换行的话,新起一行,输入>空格即可,后面不接文字

> 但> 只能放在行首才有效

### 文字被些字符包围,多重包围

> 文字被些字符包围开始

>

> > 只要再文字前面加上>空格即可

>

>  > > 如果你要换行的话,新起一行,输入>空格即可,后面不接文字

>

> > > > 但> 只能放在行首才有效

### 特殊字符处理

有一些特殊字符如<,#等,只要在特殊字符前面加上转义字符\即可

你想换行的话其实可以直接用html标签\

相关文章

  • Github Readme 使用markdown语言总结

    github传完代码,为了让读者迅速知道你代码的功能活着结构,你得填写一个ReadMe, 但是,按常规格式写的re...

  • 怎么写好README

    README格式 使用Markdown标记语言,并在在线Markdown编辑器验证 README内容 1. 项目介...

  • GitHub的ReadMe.md文档编辑语法

    README文件后缀名为md。md是markdown的缩写,markdown是一种编辑博客的语言。不过GitHub...

  • Markdown语法大全

    README 该文件用来测试和展示书写README的各种markdown语法。GitHub的markdown语法在...

  • README

    README 该文件用来测试和展示书写README的各种markdown语法。GitHub的markdown语法在...

  • Markdown语法

    README 该文件用来测试和展示书写README的各种markdown语法。GitHub的markdown语法在...

  • Git的远程单人操作

    Github是托管代码的远程仓库 README.md(README,README.markdown)可以将文件内容...

  • GitHub上README.md教程

    GitHub上README写法暨GFM语法解读 最全Markdown教程

  • Markdown批量发布到Github

    简书天然支持Markdown格式, 而Github仓库中的README.md也天然支持Markdown格式 简书后...

  • Markdown 语法

    该文件用来测试和展示书写README的各种markdown语法。GitHub的markdown语法在标准的mark...

网友评论

    本文标题:Github Readme 使用markdown语言总结

    本文链接:https://www.haomeiwen.com/subject/wxgjvttx.html