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前端教程。本项目比较简单，纯个人练手使用，项目存在不规范之处，还请包涵。

posted @ 2021-04-27 18:27 你的雷哥阅读(1073) 评论(0) 编辑收藏举报

刷新页面返回顶部

你的雷哥

GitHub上README.md的简单介绍

公告