Giter VIP home page Giter VIP logo

readme_write's Introduction

README 文件编写规范

添加标题

添加标题有两种方式

  • 第一种 使用 “#”
"=" 一个#号是一级标题 ##二级标题......以此类推, 井号
后边需要一个空格 <br>
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题
  • 第二种 使用 “=” 或 “-”
"=" 或 "-" 在文本下面写等于号 "=" ,那么上方的文本就变成了大标题,等于号的个数无限制。
一级标题
===
二级标题
---

一级标题

二级标题

添加项目符号

添加项目符号使用 "*"

  • 第一个
  • 第二个
  • 第三个

添加包裹文字的色块

添加色块使用反引号 " ` ` "
添加一个占满全部的背景使用 3个反引号 " ``` 内容 ``` "

这只一个背景的文字

这是一个占满的带背景的文字

添加换行

添加换行使用 <br> 也可以使用4个tab设置独占一行的文本

转义

转义使用 "\"

添加超链接

添加超链接 使用 [ 超链接文字 ] ( 超链接地址 )
百度

添加图片

添加图片 使用 ![ 任意文字 ]( 图片链接 )

0 超链接和图片混合

[![Build Status](https://travis-ci.org/meolu/walden.svg?branch=master)](https://travis-ci.org/meolu/walden)

|Build Status

readme_write's People

Contributors

doujianyu avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.