如何编写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月前
|
SQL JavaScript 前端开发
Github 2024-08-05 开源项目周报 Top15
根据 Github Trendings 的统计,本周(2024年8月5日统计)共有15个项目上榜。以下是根据开发语言汇总的项目数量: - Go 项目:4个 - JavaScript 项目:3个 - Python 项目:3个 - Java 项目:2个 - TypeScript 项目:2个 - C 项目:1个 - Shell 项目:1个 - Dockerfile 项目:1个 - 非开发语言项目:1个
38 2
|
2月前
|
人工智能 Rust JavaScript
Github 2024-08-26 开源项目周报Top15
根据Github Trendings的统计,本周共有15个项目上榜。以下是按开发语言汇总的项目数量:Python项目8个,TypeScript、C++ 和 Rust 项目各2个,Jupyter Notebook、Shell、Swift 和 Dart 项目各1个。其中,RustDesk 是一款用 Rust 编写的开源远程桌面软件,可作为 TeamViewer 的替代品;Whisper 是一个通用的语音识别模型,基于大规模音频数据集训练而成;初学者的生成式人工智能(第2版)则是由微软提供的18门课程,教授构建生成式AI应用所需的知识。
77 1
|
2月前
|
Rust Dart 前端开发
Github 2024-08-19 开源项目周报Top15
根据Github Trendings的统计,本周(2024年8月19日统计)共有15个项目上榜。按开发语言分类,上榜项目数量如下:Python项目最多,有7项;其次是JavaScript和TypeScript,各有3项;Dart有2项;HTML、PowerShell、Clojure和C++各1项。此外,还介绍了多个热门项目,包括Bootstrap 5、RustDesk、ComfyUI、易采集、Penpot等,涵盖了Web开发、远程桌面、自动化测试、设计工具等多个领域。
73 1
|
2月前
|
JavaScript 前端开发 Go
Github 2024-08-12 开源项目周报 Top14
本周Github Trendings共有14个项目上榜,按开发语言汇总如下:Python项目7个,TypeScript项目5个,C项目2个,JavaScript项目2个,Go和Batchfile项目各1个。其中亮点包括开发者职业成长指南、Windows激活工具、ComfyUI图形界面、AFFiNE知识库、易采集可视化爬虫等项目,涵盖多种实用工具和开源平台。
58 1
|
2月前
|
存储 JavaScript 前端开发
Github 2024-07-29 开源项目周报Top15
根据 Github Trendings 的统计,本周(2024年7月29日统计)共有15个项目上榜。按开发语言分类,项目数量如下:Python、Java、HTML 和 C 项目各有2项;TypeScript、JavaScript、Vue 和 Go 各有1项;另有1项非特定语言项目、1项 Dart 项目、1项 C++ 项目、1项 Rust 项目及1项 Jupyter Notebook 项目。这些项目涵盖了多种领域,如API开发、照片管理、PDF处理、AI技术等。
44 1
|
2月前
|
Rust JavaScript 前端开发
Github 2024-07-15 开源项目周报 Top15
根据 Github Trendings 的统计,2024年7月15日当周共有15个项目上榜。以下是按开发语言分类的项目数量汇总:Python项目5个,非开发语言项目4个,JavaScript项目3个,TypeScript项目2个,Go、Solidity和Java项目各1个,Rust项目1个。此外,介绍了多个值得关注的项目,包括免费编程学习平台 freeCodeCamp.org、免费编程书籍和学习资源清单、免费 API 集合等,涵盖了不同编程语言和技术领域。
43 1
|
2月前
|
人工智能 JavaScript API
Github 2024-07-08 开源项目周报 Top15
根据Github Trendings的统计,本周(2024年7月8日统计)共有15个项目上榜。按开发语言分类,Python项目最多,有6项;其次是C++和TypeScript,各有3项;Jupyter Notebook和JavaScript各2项;QML、非开发语言项目、Rust则各有1项。这些项目涵盖了多种领域,包括编程教育、API集合、语言模型、十六进制编辑器等。
39 1
|
2月前
|
存储 安全 Java
【事故】记一次意外把公司项目放到GitHub并被fork,如何使用DMCA下架政策保障隐私
在一次意外中,作者因三年前将测试代码遗忘在GitHub上而遭遇了代码被他人fork的问题。为解决这一危机,作者详细介绍了如何通过GitHub的DMCA下架通知流程安全删除敏感代码,包括处理私人信息和商标侵权的具体步骤。本文不仅提供了实用的操作指南,还强调了及时响应的重要性,帮助读者避免类似风险
23 0
【事故】记一次意外把公司项目放到GitHub并被fork,如何使用DMCA下架政策保障隐私
|
2月前
|
机器学习/深度学习 Rust JavaScript
Github 2024-06-24 开源项目周报 Top15
根据Github Trendings的统计,本周(2024年6月24日统计)共有15个项目上榜。按开发语言分类,项目数量如下:JavaScript项目5个,Python项目5个,TypeScript项目2个,Go项目2个,Dockerfile项目1个,C#项目1个,Java项目1个,Jupyter Notebook项目1个,Rust项目1个,Dart项目1个,Tcl项目1个。
32 0
|
2月前
|
JavaScript 前端开发 机器人
Github 2024-06-17 开源项目周报 Top15
根据Github Trendings的统计,本周(2024年6月17日)共有15个项目上榜。按开发语言分类,Python项目最多,达6项;TypeScript和JavaScript各有3项;PHP、Blade、Lua、Dart及非开发语言项目各1项。这些项目涵盖从零构建技术、智能家居、高性能数据库到情感语音模型等多个领域,体现了开源社区的多样性和创新力。
36 0
下一篇
无影云桌面