示例文档MD

作者: 陆一诗 | 来源:发表于2020-01-10 20:45 被阅读0次

此文档在更新时可能会被覆盖或删除

在使用Markdown之前,你可能需要先了解一下关于markdown的简单语法。

1.标题

  • 使用 # 表示标题,一级标题使用一个 # ,二级标题使用两个 ## ,以此类推,共有六级标题。
  • 使用 ===== 表示高阶标题,使用 --------- 表示次阶标题。
  1. # 和标题之间记得有个空格哦。
  2. ====---- 表示标题时,大于等于2个都可以表示。

2.引用

使用 > 表示引用, >> 表示引用里面再套一层引用,依次类推。

  1. 如果 >>> 嵌套使用的话,从 >> 退到 > 时,必须之间要加一个空格或者 > 作为过渡,否则默认为下一行和上一行是同一级别的引用。如示例所示。
  2. 引用标记里可以使用其他标记,如:有序列表或无序列表标记,代码标记等。

示例

这是一级引用

这是二级引用

这是三级引用

这是一级引用

3 代码块

使用3个连续的` 符号包围起来表示代码块。

  1. 本文档所有使用讲解Markdown语法标记示例的地方都是使用代码块标记的。
  2. 代码块前后都得有换行哦

示例

$(document).ready(function() {
  $('pre code').each(function(i, block) {
    hljs.highlightBlock(block);
  });
});

4 行内代码

使用``表示行内代码。本页部分文字中间的英文字母就是使用行内代码标记标记的。

示例

这是 javascript 代码

5 链接

使用 [](link) 表示行内链接。其中:

  • [] 内的内容为要添加链接的文字。
  • link 为链接地址。

示例

我觉得Markdown真是个棒棒哒的编辑器😊.

6 数学公式

$包围的区块将会解析为数学公式,连续的$$将独占一行并居中显示

示例

a \ne 0, 此方程式有两个解 ax^2 + bx + c = 0,他们是

x = {-b \pm \sqrt{b^2-4ac} \over 2a}.

7 导入图片

使用 [图片上传失败...(image-323c4f-1578660252353)] 导入图片。其中:

  • Alt text 为如果图片无法显示时显示的文字;
  • /path/to/img.jpg 为图片所在路径;

点击辅助键盘中的添加图片按钮可快捷添加图片

  1. ==本地引用==是图片直接存储到本地通过相对路径引用,无需网络连接
  2. ==上传图片==将把图片上传至图床,这样在文档或图片移动时认可访问图片

示例

Markdown

8 Todo List

小写x表示已完成, 空格表示未完成

  • 支持数学公式
  • 支持TodoList
  • 支持自定义样式
  • 支持自定义图床

9 粗体,斜体,高亮和删除线

  1. 使用 ** 或者 __ 表示粗体
  2. 使用 * 或者 _ 表示斜体
  3. 使用==表示==高亮==
  4. 使用~~表示删除
  5. *=_ 的后面不要跟空格哦

10 列表

使用 1. 2. 3. 表示有序列表,使用 *-+ 表示无序列表。

  1. 无序列表或有序列表标记和后面的文字之间要有一个空格隔开。
  2. 有序列表标记不是按照你写的数字进行显示的,而是根据当前有序列表标记所在位置显示的,如示例1所示。
  3. 无序列表的项目符号是按照实心圆、空心圆、实心方格的层级关系递进的,如例2所示。通常情况下,同一层级使用同一种标记表示,便于自己查看和管理。

例1:有序列表

  1. 第一点
  2. 第二点
  3. 第三点

例2:无序列表

  • 一级无序列表内容

    • 二级无序列表内容
    • 二级无序列表内容
      • 三级无序列表内容
      • 三级无序列表内容
  • 一级无序列表内容

    • 二级无序列表内容

11 分割线

使用 --- 或者 *** 或者 * * * 表示水平分割线。

  1. 只要 * 或者 - 大于等于三个就可组成一条平行线。
  2. 使用 --- 作为水平分割线时,要在它的前后都空一行,防止 --- 被当成标题标记的表示方式。

示例




12表格

上面空一行下面空两行

Heading Heading Heading
Cell Cell Cell
Cell Cell Cell

添加边框:

Heading Heading Heading
Cell Cell Cell
Cell Cell Cell

对齐方式:

Heading Heading Heading
Left Center Right
Left Center Right

相关文章

  • 示例文档MD

    此文档在更新时可能会被覆盖或删除 在使用Markdown之前,你可能需要先了解一下关于markdown的简单语法。...

  • 【 Android 】RecyclerView 从理论到实践

    示例项目采用:MD + MVP + Retrofit2 + Gson + RxJava2 + Realm 示例项目...

  • 一个php实现的微信支付工具集

    文档结构 │ LICENSE : 许可证 │ README.md : 说明文档英文版 │ 使用说明.md :...

  • pandoc提取word中的图片

    pandoc是文档转换利器。在将docx文档转为md文档过程中,如果直接输入pandoc -o f.md f[^f...

  • 文档示例

    文档示例 项目概述 产品名称:LaraBBS 项目代号:larabbs 官方地址:https://laravel-...

  • iOS-MD5算法

    MD5算法,代码示例如下:导入头文件:

  • editor.md #js markdown编辑器

    文档: http://editor.md.ipandao.com/ editor.md编辑器 需要依赖 jquer...

  • 七、gitbook 其他文件

    一、SUMMARY.md 1. 语法 2. 模块 二、GLOSSARY.md 1. 语法 2. 示例 三、READ...

  • vue 加密MD5,base64

    1.可自行参考npm Hbuildx 导入方法: npm install md5 2. MD5加密示例: 3. ...

  • 接口文档.md

    前后端接口文档规范 约定接口一般包括以下数据 当前接口的路径是什么? 如 /auth/register, 当前接口...

网友评论

    本文标题:示例文档MD

    本文链接:https://www.haomeiwen.com/subject/etmmactx.html