GitHub上README.md的簡單介紹

1、編輯README文件

大標題（一級標題）：在文本下面加等於號，那么上方的文字就變成了大標題，等於號的個數無限制，但一定要大於0

大標題
====

 

中標題（二級標題）：在文本下面加下划線，那么上方的文本就變成了中標題，下划線個數無限制，中標題比大標題低一級

中標題
-------

 

 1~6級標題：文本大小依次減小，以#號開頭，多少個#號就是多少級標題，#號和標題名稱要並排寫

#一級標題
##二級標題
###三級標題
####四級標題
#####五級標題
######六級標題

插入圓點符號：編輯的時候使用的是星號 *，星號后面要有一個空格，否則為普通星號

* 列表一
* 列表二
* 列表三

 

二級圓點、三級圓點：多加一個Tab，即第二行一個Tab，第三行兩個Tab

* 列表一
    * 列表二
        *列表三

 

縮進：

>縮進一
>>縮進二
>>>縮進三
>>>>縮進四
>>>>>縮進五

 

插入鏈接

[百度](http://baidu.com)

 

插入網絡圖片：，即嘆號!+方括號[]+括號()，如果不加嘆號!就會變成普通文本，方括號里可以加入一些 標識性的信息

![baidu](http://www.baidu.com/img/bdlogo.gif "百度logo")  

 

插入GITHub倉庫里的圖片：，即嘆號!+方括號[]+括號()，URL寫法：http://github.com/自己的用戶名/項目名/raw/分支名/存放圖片的文件夾/文件夾里的圖片名字

給圖片加上超鏈接：即點擊一個圖片進入指定網頁，方括號里寫自己起的標識名稱，上下兩行標識要一致。

[![baidu]](http://baidu.com)  
[baidu]:http://www.baidu.com/img/bdlogo.gif "百度Logo"  

 

插入代碼片段：在代碼上下行用```標記，注意`符號是tab鍵上面那個，要實現語法高亮，則在```后面加上編程語言的名稱

```Java
public static void main(String[] args){}
```

```javascript
document.getElementById("ts").innerHTML="Hello"
```

換行：使用標簽<br>

單行文本：前面使用兩個Tab

多行文本:每行行首加兩個Tab

部分文字高亮：使用``包圍，這個符號不是單引號，而是Tab上方，數字1左邊那個按鍵的符號

文字超鏈接格式：[要顯示的文字](鏈接的地址"鼠標懸停顯示")，在URL之后用雙引號括起來一個字符串，即鼠標懸停顯示的文本，可不寫

 

備注：如何添加README文件？

#在創建項目的時候在README那處打鈎

#如果是已經創建好項目，點擊下面的Add a README，就會進入編輯頁面：

參考模板如下

#項目介紹
本項目是基於ssm框架實現的前后端分離的項目，前端實現技術為vue，該項目則是其對應的后台接口的實現。<br>
運行效果展示：     <br>
相對應博客:   <br>
前端程序:   <br>
#使用技術
*   spring+springmvc+mybatis
*   mysql
*   maven
#運行環境
*   apache-maven-3.6.1
*   jdk1.8
*   Tomcat 8.5.491
*   mysql 8.0.15
*   依賴
```java
 <dependencies>
        
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.18</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>5.2.10.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.15</version>
        </dependency>
        <dependency>
            <groupId>com.mchange</groupId>
            <artifactId>c3p0</artifactId>
            <version>0.9.5.2</version>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>servlet-api</artifactId>
            <version>2.5</version>
        </dependency>
        <dependency>
            <groupId>javax.servlet.jsp</groupId>
            <artifactId>jsp-api</artifactId>
            <version>2.2</version>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>servlet-api</artifactId>
            <version>2.5</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis-spring</artifactId>
            <version>2.0.2</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.4</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-core -->
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.9.8</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-beans</artifactId>
            <version>5.2.10.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>5.2.0.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.2.10.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.2.10.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>servlet-api</artifactId>
            <version>2.5</version>
        </dependency>
        <dependency>
            <groupId>javax.servlet.jsp</groupId>
            <artifactId>jsp-api</artifactId>
            <version>2.2</version>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>jstl</artifactId>
            <version>1.2</version>
        </dependency>
    </dependencies>
```

#目錄結構
```java
│  pom.xml
        │  README.md
        │  ssm.sql
        │  ssm1.iml
        │
        ├─.idea
        │      .gitignore
        │      .name
        │      misc.xml
        │      workspace.xml
        │
        ├─preview
        ├─src
        │  ├─main
        │  │  ├─java
        │  │  │  └─com
        │  │  │      └─bupt
        │  │  │          ├─controller
        │  │  │          │      LoginController.java
        │  │  │          │
        │  │  │          ├─dao
        │  │  │          │      LoginMapper.java
        │  │  │          │      LoginMapper.xml
        │  │  │          │
        │  │  │          ├─pojo
        │  │  │          │      Book.java
        │  │  │          │      Pagination.java
        │  │  │          │      User.java
        │  │  │          │
        │  │  │          └─service
        │  │  │                  LoginService.java
        │  │  │                  LoginServiceImpl.java
        │  │  │
        │  │  └─resources
        │  │          applicationContext.xml
        │  │          db1.properties
        │  │          mybatis-config.xml
        │  │          spring-dao.xml
        │  │          spring-mvc.xml
        │  │          spring-service.xml
        │  │
        │  └─test
        │      └─java
        └─web
        │  index.jsp
        │
        └─WEB-INF
        web.xml


```
#功能介紹
*   登入功能
*   注冊功能
*   書籍列表展示功能
    *   分頁
*   用戶列表展示
    *   添加用戶
    *   登出
    *   修改用戶信息
    *   刪除用戶
    *   更改用戶角色
    *   分頁
    *   模糊查詢用戶
*   權限攔截功能
<br>
![演示](./preview/GIF.gif)
#更新日志
*   version[1]：  初步實現功能並上傳
#致謝和總結
感謝b站狂神的ssm教程和黑馬的vue前端教程。本項目比較簡單，純個人練手使用，項目存在不規范之處，還請包涵。