`

GitHub上编写README.md注意事项

阅读更多

 

大标题
===================================
  大标题一般显示工程名,类似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 /\>

 

如有兴趣,请关注 https://github.com/wangqianfront/markdown-syntax


备注:help

分享到:
评论

相关推荐

    仿ISO8风格手机wap站模板-ios 风格 手机 wap 蓝色.rar

    README.md文件通常是项目或软件包的说明文档,其中可能包含了如何使用模板的详细步骤、注意事项以及可能的兼容性问题等信息。而另一个文件名与标题相匹配,很可能是模板的主文件或者包含所有页面和元素的文件夹。 ...

    open_Windows_terminal

    在安装或使用之前,用户必须先阅读README.md文件,这是开发人员为用户提供的重要指南,包含了安装步骤、注意事项以及可能的问题解决方案。 在描述中提到,“powershell”是关键标签,意味着这个项目着重于改进...

    skynet 的windows VS2013编译版本

    README 文件通常包含了项目的简介、编译和运行指南,以及可能的注意事项。在这个压缩包中,README.md 很可能包含了编译 Skynet 在 Windows 上的具体步骤,以及运行示例等关键信息,是开始使用 Skynet 必须阅读的...

    微信跳一跳脚本程序

    2. README.md:项目介绍和使用指南,详细说明如何安装依赖、运行脚本以及注意事项。 3. requirements.txt:列出项目运行所需的第三方库及其版本,用户可以通过安装这些库来确保环境兼容。 4. 示例图片或配置文件:...

    programmingwithdeveloper.github.io

    因此,我们可以在"programmingwithdeveloper.github.io-main"目录下查找.md文件,了解项目的目标、使用方法和注意事项。此外,可能还会有README.md文件,它是项目的第一入口,通常包含了项目简介、安装指南、贡献...

    metrixyt.github.io

    1. **README.md**:项目介绍文件,通常用Markdown格式编写,用于解释项目的目的、如何使用以及相关注意事项。 2. **index.html**:作为网站的主页,由HTML编写,展示网站的主体内容。 3. **CSS**文件夹:存储用于...

    南开大学操作系统课程实验源码和报告.zip

    3. `README.md`: 这是项目的说明文档,通常包含项目简介、使用指南、注意事项等内容。在操作系统实验中,`README.md` 可能会详细解释实验的目的、实验步骤、预期结果以及可能遇到的问题和解决方法。它是理解实验内容...

    Android 如何远程下载安装的应用源码.rar

    7. **readme.md**:在压缩包中的`readme.md`文件很可能是详细说明了上述步骤,或者包含服务器地址、API接口的使用方法和其他注意事项。 8. **1-120RR316480-L.png**:这可能是教程中的一部分,可能是展示操作流程的...

    毕业设计-基于SCL90的心理健康测试app

    4. `README.md`和`README.en.md`:项目说明文件,Markdown格式,分别提供中文和英文的项目简介、使用方法和注意事项。 5. `ry.sh`:这可能是一个Shell脚本,与`ry.bat`类似,用于自动化Linux或MacOS环境下的任务。 6...

    个人WEB简历迷你单页模板-蓝色 个人 简历 迷你 单页.rar

    在readme文件中,可能包含了如何使用模板、修改内容以及注意事项等信息。 另一个文件是"个人WEB简历迷你单页模板_蓝色 个人 简历 迷你 单页",这应该是HTML文件,包含了实际的简历模板代码。这个模板可能包含以下...

    L-Buder-Joker.github.io

    如果有README或其他文档,它们将提供项目的目的、如何使用它以及任何特别的开发注意事项。此外,如果项目包含了其他子目录或文件,比如图片或数据文件,它们可能与网站的内容或功能有关。总的来说,这个项目提供了一...

    experiments:实验,测试和概念证明

    Kurento实验 ... 给想要引入新实验的Kurento开发人员的注意事项:GitHub积极地从Markdown文件中删除任何可能对用户有害HTML代码,例如脚本和iframe。 例如,尝试将jsFiddle演示嵌入到README.md中将不起作用。

    blinker-app-master.zip

    1. **README.md**:这是项目的基本指南,通常会包含项目介绍、如何安装和运行项目、开发人员注意事项以及贡献指南等内容。 2. **src** 或 **app** 文件夹:这里通常存放项目的源代码。代码可能是用各种编程语言如...

    Genesys2的hdmi回环测试

    7. **Readme文件**:`README.md`和`read_me.md`通常是项目文档,包含关于测试步骤、配置说明、依赖项和注意事项等信息,对于成功进行HDMI回环测试至关重要。 8. **pic**:可能包含的是测试过程中显示的图片或示意图...

    RIMEL-UCA.github.io:Le livre

    "倒入可视化器(修改后的注意事项和获得最佳奖)"这部分可能是指项目中包含一个或多个可视化工具,这些工具可能经过了修改,以适应特定的逆向工程或软件工程任务。"mais pour faire référence à votre chapitre,...

    vant演示的集合.zip

    用户可以从中获取关于压缩包内容的基本指导和注意事项。 2. "vant-demo_master.zip":这是一个子压缩文件,可能包含了Vant组件库的示例代码仓库(可能从GitHub克隆而来),名字中的“master”通常指的是主分支,...

    开源项目-Eun-goremovelines.zip

    1. `README.md`: 项目的说明文档,会详细介绍如何使用这个工具,它的功能、安装步骤以及任何需要注意的事项。 2. `go.mod` 和 `go.sum`: 这两个文件是Go模块系统的一部分,用于管理依赖关系和验证依赖的完整性。 3. ...

    GoogleVRForUnity.zip

    3. `README.md`:这是SDK的基本介绍和使用说明,通常包括快速入门教程和注意事项。开发者应首先查看此文件以了解SDK的基本用法。 4. `GoogleVRForUnity_1.200.1.unitypackage`:这是Unity的导入包,包含所有需要的...

    blog-aarushgupta.github.io:Aarush Gupta博客的源代码

    GitHub仓库还可能包含`README.md`文件,这是一个Markdown格式的文档,用来介绍项目背景、如何构建和运行博客,以及任何特别的注意事项。Markdown是一种轻量级的标记语言,易于阅读和编写。 总的来说,通过分析...

    初赛复赛程序.zip

    3. **README.md**:项目介绍和使用指南,包括如何运行程序、预期输出和注意事项等。 4. **测试数据**:可能包括输入文件和对应的输出文件,用于验证代码的正确性。 5. **提交记录**:如果是从版本控制库导出的,可能...

Global site tag (gtag.js) - Google Analytics