如何编写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 /\> 

* 在行首加点 
行首输入*,空格后输入内容即可 
目录
相关文章
|
3月前
|
人工智能 JavaScript 前端开发
Github 2024-10-28 开源项目周报 Top15
本周GitHub热门项目涵盖Svelte、Open Interpreter、PowerShell等,涉及Web开发、AI助手、自动化工具等领域,Python、JavaScript为主流语言,展现开源技术活跃生态。(239字)
452 19
|
3月前
|
人工智能 JavaScript 前端开发
Github 2024-11-04 开源项目周报 Top14
本周GitHub热门项目涵盖屏幕截图转代码、网页监控、低代码开发等。Python与TypeScript主导,亮点项目包括AI生成代码工具、开源社交应用Bluesky及机器人框架LeRobot,展现AI与自动化技术的快速发展趋势。
213 15
|
3月前
|
人工智能 JavaScript Docker
Github 2024-11-11 开源项目周报 Top15
本周GitHub热门项目涵盖多领域:Python与TypeScript领跑,包括屏幕截图转代码、本地文件共享、PDF处理、AI开发代理等。亮点项目如screenshot-to-code、LocalSend、OpenHands及Diagrams,兼具创新与实用性,广受开发者关注。
281 13
|
3月前
|
人工智能 算法 JavaScript
Github 2024-10-14 开源项目周报 Top14
本周GitHub热门项目共14个,Python项目占7席。涵盖算法实现、生成式AI、金融分析、目标检测等领域,包括TheAlgorithms系列、OpenBB金融平台、Ultralytics YOLO11、Manim动画框架等,展现开源技术多元发展态势。
142 8
|
3月前
|
人工智能 Rust JavaScript
Github 2024-10-07 开源项目周报 Top15
本周GitHub热门项目共15个,Python项目占比最高达7个。榜首为Python算法实现集合TheAlgorithms/Python,Star数超17万;其他亮点包括Godot游戏引擎、OpenBB金融平台、ToolJet低代码框架及新兴AI相关项目如Crawl4AI、Llama Stack等,涵盖游戏、金融、AI、理财等多个领域。
145 4
|
3月前
|
人工智能 Rust 算法
Github 2024-09-30 开源项目周报 Top15
本周GitHub热门项目揭晓:Python主导,AutoGPT居首,涵盖AI、编程、数学动画等领域,助力开发者探索前沿技术。
147 4
|
3月前
|
人工智能 JavaScript 前端开发
Github 2024-09-16 开源项目周报 Top14
本周GitHub热门项目涵盖Python、TypeScript、Go等语言,React居首。亮点包括微软PowerToys、Node版本管理器、AI证件照工具HivisionIDPhotos及端侧大模型MiniCPM等。
129 2
|
3月前
|
Rust JavaScript 安全
Github 2024-09-02 开源项目周报 Top13
本周GitHub热门项目涵盖AI、开发工具与开源替代品。包括Notion替代AppFlowy、Airtable替代NocoDB、云平台Coolify及可观察性平台OpenObserve等,涉及Python、TypeScript、Rust等语言,聚焦效率、隐私与自动化。
190 1
|
4月前
|
人工智能 编解码 JSON
不看后悔!GitHub 开源 MultiTalk .8k star 强大的人语音+图像绑定项目
MultiTalk 是 GitHub 上的开源项目,具备音频驱动、多人对话视频生成功能。支持多路音频与图像绑定,实现高同步唇动与角色互动,适用于教学、虚拟人及短视频创作,已获 8k 星标。
341 0
|
4月前
|
安全 数据可视化 项目管理
精品,Github 5000+ star,小型研发团队必备商业开源项目
DooTask 是一款开源在线项目任务管理工具,具备文档协作、流程图、任务分发、IM沟通等功能,支持私有部署与数据加密,已在 GitHub 获得 5000+ 星标,适合中小团队提升协作效率。
206 0

热门文章

最新文章