markdown文档:一个简单标记语言的使用及GitHub实际应用

2023-10-26

目录

1.什么是Markdown?

2.Markdown与HTML的简单对比

3.Markdown的基本语法

 4.GitHub中Markdown的使用

4.1.GitHub上自定义的md文件格式与markdown pad(IDE)的区别,

4.2.GitHub上超链接的使用方法(遇到的错误及修改)

5.应用:论文项目中YOLOV5的md文档

参考文献


1.什么是Markdown?

Markdown是一种轻量级的标记语言(lightweight markup language),并不是编程语言,它用于使用纯文本编辑器创建格式化文本。主要用于博客即时消息在线论坛协作软件文档页面和自述文件。Markdown 是一种最小的标记语言,可以使用普通的文本编辑器进行读取和编辑,但有专门设计的编辑器可以使用样式预览文件,这些样式适用于所有主要平台【1】。

Markdown 是一种用来书写网页内容的方法。它实际上在使用我们在日常生活中用来书写和发送信息的纯文本格式来书写。纯文本仅由常见的字母、文字和一些特殊符号来构成,例如星号(\*)和反引号(`)。

2.Markdown与HTML的简单对比

3.Markdown的基本语法

3.1.斜体和加粗(Italics and Bold)

斜体:句子或单词前后加下划线 :  _ 内容 _

实例1

加粗: 使用两个星号写到文本前后:  **内容**  

实例2

 斜体和加粗混用实例3

实例4:加粗的同时设置为斜体,虽然不分顺序,但是第二个相对更容易区分。

 3.2.标题

这里有6种不同的标题,他们的大小递减

 在Markdown里面添加标题,你要在文本的前面添加一个井号 (#)。 你可以键入多个井号来生成你想要的几级标题。 例如,一级标题你需要添加一个井号 (# 一级标题), 当你需要一个三级标题时你就要三个井号 (### 三级标题).

实例5

 - 不能将标题加粗,但是可以将其中的文字设置为斜体。

 3.3.超链接

 在 Markdown 中有两种不同的链接种类,分为内联链接和全局链接,但是它们的渲染方式完全相同。

3.3.1内联链接

内联链接:创建一个内联的链接, 你需要将被链接的文本用方括号 ( [ ] )包起来, 然后将链接地址用圆括号 ( ( ) )起来。 *这些括号及以后出现的括号均为英文半角符号,译者注。 比方说,创建一个写着 "Visit Github!" 到 www.github.com 的超链接, 你应该使用Markdown这样书写: [Visit GitHub!](www.github.com).

实例6

实例7:加粗局部,整句话连接到新链接

 实例8:标题设置为四号,然后将短语"the BBC" 链接到 www.bbc.com/news:

 3.3.2.全局链接

另外一种链接叫做 全局 链接,也就是这个链接链接到文档的另外一个位置。格式如下

  [内容1][网址名称1].
  [内容2][网址名称2].
  [内容3][网址名称1].
#内容为链接的单词或句子,网址名称为定点名称,下面为定点名称指向的网址。
     [网址名称1]: www.github.com
     [网址名称2]: www.google.com

 #优点:减少链接重复

上面的“全局”链接是第二组方括号: [another place] 和 [another-link]。在Markdown文档的底部, 这些方括号被适当的定义为外部网页链接。使用全局链接的一个优点是如果文档中有多个指向统一网址的链接只需要书写或更新一次。 例如,我们觉得将所有的 [another place] 链接到其它的地方,我们只需要更改那一个全局链接即可。

全局链接本身不会被Markdown渲染出来,需要提供同名的用方括号包裹的标签来定义它们,然后是冒号,然后是链接。[内容]:链接

实例9:在底部的文本框,写一些全局链接。将第一个链接命名为 "a fun place", 然后将它链接到 www.zombo.com;将第二个链接到 www.stumbleupon.com。

 3.4.图片

添加图片也有两种方法,分为内联图片链接和。就像链接一样,并且渲染出来的结果是一样的。 添加链接和图片的区别仅仅在于前面的感叹号 ( ! )。![内容](链接)

3.4.1.内联图片链接

第一种图片的格式叫做 内联图片链接。创建一个内联的图片链接, 需要输入一个感叹号 ( ! )将方括号 ( [ ] )中的描述性文本包起来, 然后使用圆括号 ( ( ) )包链接地址。 (描述性文本是为查看解释图片短语或者句子的语句。)

实例10:创建一个描述文本为"Benjamin Bannekat"的内联的链接地址为 https://octodex.github.com/images/bannekat.png 的图片, 应该这样写Markdown: ![Benjamin Bannekat](https://octodex.github.com/images/bannekat.png)

实例11:在下面的文本框里面,将链接转换为图片,并且在方括号内填写描述文本"A pretty tiger":

 

3.4.2.全局图片链接

对于全局图片来说,使用同样的标签模式。在标记前添加一个感叹号然后跟两个方括号。 对于描述文本来说,应该添加两个或以上的图片标签,比如这样: ![The founding father][Father] 在Markdown页面的底部, 定义一个图片标签,就像这样: [Father]: http://octodex.github.com/images/founding-father.jpg.

实例12:在文本框底部,放置了一些全局图像; 给第一个全局图片标签命名为 "Black", 然后把它链接到 https://upload.wikimedia.org/wikipedia/commons/a/a3/81_INF_DIV_SSI.jpg; 给第二个图片链接到http://icons.iconarchive.com/icons/google/noto-emoji-animals-nature/256/22221-cat-icon.png

 3.5.引用块

如果需要为其他来源的内容添加特殊的格式来引起读者的注意, 或为其他杂志的文章设计特殊的格式,那么 Markdown 的引用块语法将会非常有用。 引用块是一个拥有特殊格式的句子或段落,为了引起读者的注意。例如:

“无为而治的罪是所有七种罪中最致命的。有传言说,要使邪恶的人实现其目的,只需要好人无所事事。”

要创建一个引用块,只需要在行首添加大于号(>)。>内容

实例13:

实例14: 可以在每一行引用前都添加一个大于号。 当有多个段落时,他就是一个整体的块。

 实例15:以上内容的全部应用、斜体,加粗,图片,超链接

 3.6.列表

这个世界上有俩种不同的列表:无序列表和有序列表。 无序列表前是黑点,有序列表前是数字。

要创建一个无序列表,需要在每一个列表项前加一个星号( * )。 每个列表要占一行。例如,一个杂货店商品的列表可以用 Markdown 写成这样* 内容

* 牛奶
* 鸡蛋
* 三文鱼
* 黄油

这个 Markdown 列表将会显示成这样:

  • 牛奶
  • 鸡蛋
  • 三文鱼
  • 黄油

实例16 

 注意:中间一定要加空格

实例17:有序列表

  注意:数字+点 后一定要加空格

实例18:无序列表和斜体,加粗,链接一起的实现

如果需要将一个列表变得更深,或者,将一个列表放置在另一个列表中。 不用担心,因为 Markdown 的语法完全相同。 只需要在每个星号前比上一个项目多缩进一个空格。

实例19:将人物的特征变成子列表。

3.7.段落

分为段落换行段落间换行。可以通过在每一行的结尾输入俩个空格来实现这一点。 空格是不可见的,输入的内容就像这样:

我有自相矛盾么?··
很好,那我是在自相矛盾了,··
(我是庞大的,我承载着很多个自己。)

每个点( · )都代表一个空格:内容+空格

实例20

- 注意:是空格,不是点 

 4.GitHub中Markdown的使用

4.1.GitHub上自定义的md文件格式与markdown pad(IDE)的区别,

markdown pad(IDE)

* 代表列表

GitHub上自定义的md文件:

- 代表列表

- 超链接如果不生效的话,需要顶头

- GitHub仓库可直接引用作网页

4.2.github上超链接的使用方法(遇到的错误及修改)

错误1:markdown的超链接无法生效

解决办法:超链接如果不生效的话,需要顶格(如图)

 显示为:

5.应用:论文项目中YOLOV5的md文档

<div align="center">
<p>
   <a align="left" href="https://ultralytics.com/yolov5" target="_blank">
   <img width="850" src="https://github.com/ultralytics/yolov5/releases/download/v1.0/splash.jpg"></a>
</p>
<br>
<div>
   <a href="https://github.com/ultralytics/yolov5/actions"><img src="https://github.com/ultralytics/yolov5/workflows/CI%20CPU%20testing/badge.svg" alt="CI CPU testing"></a>
   <a href="https://zenodo.org/badge/latestdoi/264818686"><img src="https://zenodo.org/badge/264818686.svg" alt="YOLOv5 Citation"></a>
   <a href="https://hub.docker.com/r/ultralytics/yolov5"><img src="https://img.shields.io/docker/pulls/ultralytics/yolov5?logo=docker" alt="Docker Pulls"></a>
   <br>
   <a href="https://colab.research.google.com/github/ultralytics/yolov5/blob/master/tutorial.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"></a>
   <a href="https://www.kaggle.com/ultralytics/yolov5"><img src="https://kaggle.com/static/images/open-in-kaggle.svg" alt="Open In Kaggle"></a>
   <a href="https://join.slack.com/t/ultralytics/shared_invite/zt-w29ei8bp-jczz7QYUmDtgo6r6KcMIAg"><img src="https://img.shields.io/badge/Slack-Join_Forum-blue.svg?logo=slack" alt="Join Forum"></a>
</div>
<br>
<div align="center">
   <a href="https://github.com/ultralytics">
   <img src="https://github.com/ultralytics/yolov5/releases/download/v1.0/logo-social-github.png" width="2%"/>
   </a>
   <img width="2%" />
   <a href="https://www.linkedin.com/company/ultralytics">
   <img src="https://github.com/ultralytics/yolov5/releases/download/v1.0/logo-social-linkedin.png" width="2%"/>
   </a>
   <img width="2%" />
   <a href="https://twitter.com/ultralytics">
   <img src="https://github.com/ultralytics/yolov5/releases/download/v1.0/logo-social-twitter.png" width="2%"/>
   </a>
   <img width="2%" />
   <a href="https://youtube.com/ultralytics">
   <img src="https://github.com/ultralytics/yolov5/releases/download/v1.0/logo-social-youtube.png" width="2%"/>
   </a>
   <img width="2%" />
   <a href="https://www.facebook.com/ultralytics">
   <img src="https://github.com/ultralytics/yolov5/releases/download/v1.0/logo-social-facebook.png" width="2%"/>
   </a>
   <img width="2%" />
   <a href="https://www.instagram.com/ultralytics/">
   <img src="https://github.com/ultralytics/yolov5/releases/download/v1.0/logo-social-instagram.png" width="2%"/>
   </a>
</div>

<br>
<p>
YOLOv5 									
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

markdown文档:一个简单标记语言的使用及GitHub实际应用 的相关文章

  • 如何将 Liquid 标签突出显示在有序列表中?

    这就是我want页面为 ol li first li li second code code li li third li ol 这就是我正在写的 1 first 2 second highlight ruby code here endh
  • GitHub、Gerrit、Hudson(Jenkins) 工作流程

    我刚刚开始一起使用 GitHub Gerrit 和 Hudson Jenkins 我需要一些关于工作流程的想法 我们想使用 GitHub 作为我们的主要远程存储库 我们希望主要使用 Gerrit 进行代码审查 但也用于 Hudson 中的构
  • git 将上游设置为原点

    我一直在阅读和使用 git 但仍然对 起源 一词感到困惑 我有一个本地存储库 并在其上创建了一个新分支 这个新分支是我主人的副本 我的主控是原始主控的分叉 是其他人制作的另一个存储库 并且在某些提交方面领先于原始主控 而在其他方面则落后于原
  • .gitignore 文件是否适用于所有分支?

    Master 分支中的 gitignore 文件是否适用于其他分支 在 创建本地 gitignore 部分中https help github com en articles ignoring files https help github
  • 手动合并拉取请求

    所以我在github上有以下情况 我从创建了一个新分支mainbranch并命名为userstory1 我在分支中推送了我的更改userstory1并向我的同事提出了拉取请求 他发现文件夹结构不正确 因此将我的代码文件夹重命名为mainbr
  • Git:推送到多个远程

    Short 如果您将多个远程存储库链接到本地 文件 是否有一种方法可以同时推送到它们 Long 由于工作原因 我的代码必须使用gitlab和github遥控器 因此 一旦我进行了一些本地更改 我就想更新这两个存储库 我的 git confi
  • Github API:过早获取超出速率限制的问题

    我正在构建一个应用程序来获取问题和拉取请求 https developer github com v3 超过 1K 的 github 存储库 就像这样 curl i https api github com repos user repo
  • 是否可以在 Multimarkdown 中执行“制表符”?

    有没有办法在Multimarkdown语法中实现制表符 我的目标是这样的 项目 选项卡 gt 值 其他项目 选项卡 gt 值 还有一项 gt 价值 我可以意识到通过table https stackoverflow com a 405896
  • Git lfs(大文件存储)表示 lfs 管理的文件在 git lfs pull 后被修改

    我有一个存储库的工作副本 它使用 git lfs 来存储一些大文件 我安装了 git lfs 二进制文件 但可能没有在工作副本中运行 git lfs install 当我想在添加 lfs 文件后更新本地工作副本时 我执行以下命令 git p
  • 《美人鱼》中的空间

    我有一个 md文件已保存 我正在使用 Atom 和 Mermaid Preview 包查看它 我将关闭他们的 GitHub 页面上的示例 graph TD A gt B A gt C B gt D C gt D 这渲染得很好 但是如何在文本
  • 合并/其他提交交错后的交互式变基

    我典型的 git 工作流程是从 master 分支中创建一个功能分支 进行小的提交 同时定期从 master 合并以跟上 然后我在 github 上打开一个拉取请求 当它被接受时我将删除该分支 我想以交互方式进行更多变基 但是当我这样做时
  • 拉取部署、github 操作和 ssh 密钥

    比方说 我想使用 GitHub 操作和拉取策略来设置部署流程 所以我有一个 Ubuntu 服务器 我复制服务器的公共 ssh 密钥 将其添加到我的 GitHub 帐户 然后我可以从 Ubuntu 服务器克隆 构建并运行应用程序 那太好了 但
  • 发生未知错误:用户在 Xcode 13.3 上拒绝了 github.com (-17) 的证书

    我遇到了这个奇怪的错误 每次我尝试将本地 git 存储库推送到 Github 时 这个错误都会让我烦恼 希望有人能帮我解决这个奇怪的事情 我的工作环境 Xcode 13 3 就我而言 网络调试代理导致了这个问题 看来 Xcode 固定了 g
  • git clone 永远挂在 github 上

    当我按照 github 中的第 5 点 测试所有内容 时guide http help github com linux set up git ssh 命令也永远挂起 根据该指南 我应该看到一条消息 Github 不提供 shell 访问
  • 带有 OAuth 访问令牌的 GitHub 克隆

    在脚本中 我尝试使用 OAuth 令牌克隆 GitHub 存储库 根据本教程 https github com blog 1270 easier builds and deployments using git over https and
  • 停止pandoc自动添加id

    我在用Pandoc对Markdown的扩展 http pandoc org MANUAL html pandocs markdown来生成 HTML 以下降价 test specificId test2 test3 生成以下 html h1
  • 无法签出远程 git 分支

    我在 github 本地克隆中 以下是分行列表 git branch a master online demo remotes origin HEAD gt origin master remotes origin develop remo
  • 使用 Github for Windows 通过 SSH 处理自己的私有 Git

    现在 我正在使用 msysgit 来使用 SSH 来处理存储在 ec2 Amazon 云服务器上的我自己的私有存储库 到目前为止 我已经能够通过 Git Bash 成功连接到这些存储库 使用 ssh keygen 创建 ssh rsa 公钥
  • 创建 git 分支并将其合并到史诗分支

    我正在开发一个项目 例如 SO bubbleSort 我需要创建一个名为 feature version 1 的史诗分支 因此从这个史诗分支中很少有开发人员进行开发 因此为此 他们需要创建一个将分支与史诗分支分开 我的问题是我们如何合并这些
  • 如果我设置 echo=FALSE,R Markdown 会使自定义绘图消失

    我创建了一个自定义函数 它将 mfrow 设置为 nxn 并根据数据框的输入列表创建 n 2 个散点图 每个图上有多个数据集 我的绘图函数的签名如下所示 plot return list lt function df list num pl

随机推荐

  • go语言context保存上下文

    contxt保存上下文适合全局参数传递 而普通的参数传递就没必要用context 因为不好维护 关于context具体用法可以参考 https studygolang com articles 23247 fr sidebar packag
  • java函数的定义方法_java函数的定义以及使用方法介绍

    java函数的定义以及使用方法介绍 发布时间 2020 04 24 16 28 40 来源 亿速云 阅读 116 作者 小新 今天小编给大家分享的是java函数的定义以及使用方法介绍 相信很多人都不太了解 为了让大家更加了解java函数 所
  • AJAX&&JSON

    课程笔记Day46 AJAX JSON 综合案例 第一章 AJAX 第01节 基础理论 1 概念说明 1 什么是 AJAX AJAX是一项技术合集 他是由一套技术组合得到的新技术方案 异步请求技术 2 AJAX有什么作用呢 使用Ajax技术
  • C++ 删除文本数据中第一个元素

    由于项目需要删除第一个字符 然后按照相同顶格显示 如下 v 279 268005 37 345402 2 081520 v 280 971985 37 074699 1 353890 v 279 015991 44 888100 1 609
  • 手把手教你搭建国产嵌入式模拟器SkyEye开发环境

    SkyEye介绍 SkyEye是一个开源软件 OpenSource Software 项目 中文名字是 天目 SkyEye的目标是在通用的Linux和Windows平台上实现一个纯软件集成开发环境 模拟常见的嵌入式计算机系统 这里假定 仿真
  • 《编译原理》笔记整理

    编译原理 笔记整理 1 1 编译原理 引论 基本概念 发展 机器语言 汇编语言 高级语言 工具语言 基本概念 翻译程序 把某一种语言程序 称为源语言程序 等价的转换成另一种语言程序 称为目标语言程序 的程序 如 中英互译系统 DBMS语言
  • Java工程师成长之路

    Java工程师成长之路 李颜芯 欢迎大家收看CSDN的视频节目 今天我们的有关话题是Java工程师的成长之路 今天我们请到两位老师 和我们一起探讨这个问题 首先请两位老师作一下自我介绍 李翊 大家好 我是来自于东方标准人才服务有限公司 原来
  • 深度学习安装篇之二:ubuntu18.04+pycharm-2021.3安装

    一 软件下 载 1 申请学生或教师用户 可以免费使用专业版本 有学校的电子邮箱edn or 社区免费版 2 官网下载软件 PyCharm the Python IDE for Professional Developers by JetBr
  • arduino-esp32:LVGL中文字库(通用)

    导航 概述 系统自带中文字库 使用自带中文字库 制作专属字库 使用专属字库 VS模拟器 效果 arduino esp32 效果 小结 概述 标题是arduino esp32只是因为平台是这个 LVGL默认的字库是英文的 当然其字库文件里也有
  • 华为OD机试 Python 【食堂供餐】

    题目 员工食堂现在供应盒饭 我们的目标是让员工不用排队直接取餐 根据过去的取餐统计 我们想知道每单位时间 食堂至少要制作多少盒饭 才能确保每个员工都不用等待 输入 3 14 10 4 5 输出 3 输入 3 这表示在一个特定的时间段内 共有
  • YOLO综述:从YOLOV1到YOLOV8

    YOLO综述 从YOLOV1到YOLOV8 ABSTRACT 1 Introduction 2 YOLO Applications Across Diverse Fields 3 Object Detection Metrics and N
  • nginx报错nginx: [error] open() “/run/nginx.pid” failed (2: No such file or directory)

    nginx error open run nginx pid failed 2 No such file or directory 日期 2018 11 03 来源 Linux公社 作者 醉落红尘 字体 大 中 小 CentOS 7 5下启
  • vue 按钮 权限控制

    vue 按钮 权限控制 前言 在日常项目中 会碰到需要根据后台接口返回的数据 来判断当前用户的操作权限 必须当有删除权限时 就显示删除按钮 没有这个权限时 就不显示或者删除这个按钮 通过查找资料 通过vuex来实现这个功能 步骤 1 定义b
  • PID算法

    比例P 数值固定 不会随着情况调整 增幅器 积分I 比例P过小 增幅器补充 抑制器 微分D 比例P过大 抑制器削减 比例P 偏差量 目标量 传感器 比例P 偏差量 比例P系数 执行量 比例P 积分I 偏差量 目标量 传感器 积分I 积分I
  • 得到课程:冯雪·科学减肥16讲

    发刊词 减肥的动机 是为了健康 更是为了提高你的魅力 提高你的社会竞争力 减肥的实质 是改变生活方式 换一种新的人生 只有跟一群志同道合的人一起走 才能走得更远 最终减肥成功 基本原理 01 终点 三个目标一个都不能少 只要体重 体脂和体型
  • 小样本学习(FSL):Few-shot Learning 综述【模型微调(Fine-tunning)、数据增强、迁移学习(Transfer Learning)】

    分类非常常见 但如果每个类只有几个标注样本 怎么办呢 比如 我们打造了一个智能对话开发平台以赋能第三方开发者来开发各自业务场景中的任务型对话 其中一个重要功能就是对意图进行分类 大量平台用户在创建一个新对话任务时 并没有大量标注数据 每个意
  • 启发式搜索算法:A算法(全局、局部择优算法)+A*算法 解决八数码问题

    文章目录 1 A 算法 1 1 全局择优算法 1 1 1 求解八数码 1 2 局部择优算法 1 2 1 求解八数码 2 A 算法 2 1 解决八数码难题 参考博客 人工智能搜索策略 A 算法 1 A 算法 在图搜索算法中 如果能在搜索的每一
  • 华为OD机试 - IPv4地址转换成整数(Java)

    题目描述 存在一种虚拟IPv4地址 由4小节组成 每节的范围为0 255 以 号间隔 虚拟IPv4地址可以转换为一个32位的整数 例如 128 0 255 255 转换为32位整数的结果为2147549183 0x8000FFFF 1 0
  • 相关概念地址笔记

    公平锁与非公平锁 https www jianshu com p f584799f1c77 java socket编程https www cnblogs com mingforyou p 3258418 html java四种引用类型htt
  • markdown文档:一个简单标记语言的使用及GitHub实际应用

    目录 1 什么是Markdown 2 Markdown与HTML的简单对比 3 Markdown的基本语法 4 GitHub中Markdown的使用 4 1 GitHub上自定义的md文件格式与markdown pad IDE 的区别 4
Powered by Hwhale