GithubHelp home page GithubHelp logo

readme's Introduction

快速上手 markdown ,写出好看的 readme 文档

该文档呈现的是显示效果,具体使用请点击编辑按钮看实际使用的 markdown 标签的使用

等级标题表示的方法如下:

一级标题

二级标题

三级标题

四级标题

学习编写readme,文本下面是 = 会代表这行会是一个大标题,等于号的个数无限制,这个相当于一级标题,下面会有一个分界线

文本下面是----表示中标题,个数没有限制,这个相当于二级标题下面会有一个分界线

文本编辑如何换行呢? 用 html 中 的 br 标签就好!

Tab 按键会有如下的显示效果,添加两个 Tab 按键

            hello world
            helllo world
            hello world

下面的用法可以把内容进行区域化,

爱情是理解和体贴的别名。
——泰戈尔

代码块的表示方法

System.out.prinltn("hello world");

字体加粗

你好这是一个残酷的世界

字体斜体

你好这是一个残酷的世界

字体高亮

你好这是一个残酷的世界

插入链接

例子: 百度  

圆点符号

  • 这里显示的是一个圆点,记得*后面有空格

圆点的层级结构

  • 一级

    • 二级相对一级添加了两个 Tab

      • 三级相对二级添加了两个 Tab

缩进

太爷爷

爷爷

爸爸

儿子

孙子

插入图片

如下格式括号中写的是图片的 url 同时还可以在括号里面添加双引号鼠标移动到图片会有提示效果

Google

把图片提交到 GitHub 的仓库以后在 README.md 显示,括号里面的地址是在仓库里面打开图片在浏览器里显示的地址

点击图片进行超链接,如下所示:

谷歌

添加表格

添加普通表格:

表头1 表头2
Content Cell Content Cell
Content Cell Content Cell

靠左,居中,靠右:

靠左 居中 靠右
123 456 7890
12345 789000 098765
762hdgkj tyqiutyqoieu hgjagkjan

在表格中插入图片:

图片 描述
Google 这是 Google 的 Logo.

添加视频链接

这种方法添加视频跟添加图片链接的方式相同,点击链接到视频:

添加选框

用法说明 : - 后面有一个空格, [ ] 添加 x 代表的是选中,没加 x 就是没有选中,没选中需要在 [ ] 中添加一个空格

  • 这是测试一,被选中了
  • 这是测试二,没被选中
  • 这是测试三,没被选中
  • 这是测试四,选中了

readme's People

Contributors

zempty-zhaoxuan avatar

Stargazers

 avatar

Watchers

 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.