如何编写github项目的README.md文件?

简介:

针对中文,演示Markdown的各种语法

具体的项目效果可以参考:https://github.com/guoyunsky/Markdown-Chinese-Demo  

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

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

### 单行文本框 
    这是一个单行的文本框,只要两个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)<br /> 
2.[点击这里我你可以链接到我的博客](http://guoyunsky.iteye.com)<br /> 


###只是显示图片 
![github](http://github.com/unicorn.png "github") 

###想点击某个图片进入一个网页,比如我想点击github的icorn然后再进入www.github.com 
[![image]](http://www.github.com/) 
[image]: http://github.com/github.png "github" 


### 文字被些字符包围 
> 文字被些字符包围 

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

> 如果你要换行的话,新起一行,输入>空格即可,后面不接文字 
> 但> 只能放在行首才有效 

### 文字被些字符包围,多重包围 
> 文字被些字符包围开始 

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

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

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

### 特殊字符处理 
有一些特殊字符如<,#等,只要在特殊字符前面加上转义字符\即可<br /> 
你想换行的话其实可以直接用html标签\<br /\> 

* 在行首加点 
行首输入*,空格后输入内容即可 
目录
相关文章
|
2月前
|
人工智能 文字识别 异构计算
关于github开源ocr项目的疑问
小白尝试Python OCR学习,遇到报错。尝试Paddle OCR部署失败,Tesseract OCR在Colab误操作后恢复失败。EasyOCR在Colab和阿里天池Notebook成功,但GPU资源不足。其他平台部署不顺,决定使用WebUI或阿里云轻应用。求教OCR项目部署到本地及简单OCR项目推荐。
31 2
|
2月前
|
人工智能 自然语言处理 iOS开发
『GitHub项目圈选19』推荐5款本周 让人爱不释手 的开源项目
『GitHub项目圈选19』推荐5款本周 让人爱不释手 的开源项目
|
2月前
|
存储 Web App开发 人工智能
『GitHub项目圈选18』推荐5款本周 超实用 的开源项目
『GitHub项目圈选18』推荐5款本周 超实用 的开源项目
105 1
|
2月前
|
人工智能 物联网 机器人
『GitHub项目圈选17』推荐5款本周 火火火 的AI开源项目
『GitHub项目圈选17』推荐5款本周 火火火 的AI开源项目
239 1
|
2月前
|
JSON 搜索推荐 程序员
『GitHub项目圈选15』推荐5款本周 深受程序员喜爱 的开源项目
『GitHub项目圈选15』推荐5款本周 深受程序员喜爱 的开源项目
|
2月前
|
人工智能 自然语言处理 NoSQL
『GitHub项目圈选13』推荐5款本周 让人爱不释手 的开源项目
『GitHub项目圈选13』推荐5款本周 让人爱不释手 的开源项目
|
7天前
|
Linux API 开发者
【专栏】如何在GitHub正确地使用 Curl 下载文件?
【4月更文挑战第28天】本文介绍了如何使用`curl`命令从GitHub下载文件。基础操作包括获取文件的克隆URL,打开终端输入`curl -O &lt;file_clone_url&gt;`,执行命令以下载文件。文章还提及了代理设置、认证和错误处理等高级应用,帮助开发者更高效地管理代码和资源。掌握`curl`能提升开发效率和解决问题的能力。
|
11天前
|
Shell 开发工具 git
如何在GitHub上传项目
如何在GitHub上传项目
13 1
|
12天前
|
前端开发 JavaScript 网络安全
Git(3) 使用Github管理项目
Git(3) 使用Github管理项目
25 0
|
19天前
|
程序员
借用GitHub将typora图片文件快速上传CSDN
借用GitHub将typora图片文件快速上传CSDN