Cloud-Link's blog Cloud-Link's blog
首页
  • 开发资源
  • 人员动态
  • 新人训练
  • 奖惩通报
  • 通讯录
项目资产
  • 快速指南
  • 后端框架
  • 前端框架
  • 业务模块
  • 基础理论
    • 前端
    • 后端
    • 数据库
    • 工具类
  • 常用
  • 网站
  • 资源
  • Vue资源
  • 分类
  • 标签
  • 归档
关于
首页
  • 开发资源
  • 人员动态
  • 新人训练
  • 奖惩通报
  • 通讯录
项目资产
  • 快速指南
  • 后端框架
  • 前端框架
  • 业务模块
  • 基础理论
    • 前端
    • 后端
    • 数据库
    • 工具类
  • 常用
  • 网站
  • 资源
  • Vue资源
  • 分类
  • 标签
  • 归档
关于
  • 前端

  • 后端

  • 数据库

  • 工具类

    • Vepress

      • 介绍
      • 快速上手
      • 目录结构
      • 核心配置和约定
      • 文档编写和一级标题
      • 自动生成front matter
      • 批量操作front matter工具
      • Markdown 容器
      • Markdown使用教程
      • Markdown 中使用组件
        • 标记
        • 代码块选项卡
      • 提高文档表现力
    • Git

    • npm

  • Vue

  • TypeScript

  • React

  • 知识库
  • 工具类
  • Vepress
2021-06-18

Markdown 中使用组件

主题的内置组件可以直接在Markdown文件中以类似html标签的方式使用。

# 标记

  • Props:

    • text- string
    • type - string, 可选值: tip | warning | error,默认: tip
    • vertical - string, 可选值: top | middle,默认: top
  • Usage:

你可以在标题或其他内容中使用标记:

#### 《沁园春·雪》 <Badge text="摘"/>
北国风光<Badge text="注释" type="warning"/>,千里冰封,万里雪飘。

> <Badge text="译文" type="error" vertical="middle"/>: 北方的风光。
1
2
3
4

效果:

# 《沁园春·雪》 摘

北国风光注释,千里冰封,万里雪飘。

译文: 北方的风光。

# 代码块选项卡 v1.8.0 +

在<code-group>中嵌套<code-block>来配合使用。在<code-block>标签添加title来指定tab标题,active指定当前tab:

<code-group>
  <code-block title="YARN" active>
  ```bash
  yarn add vuepress-theme-trx -D
  ```
  </code-block>

  <code-block title="NPM">
  ```bash
  npm install vuepress-theme-trx -D
  ```
  </code-block>
</code-group>
1
2
3
4
5
6
7
8
9
10
11
12
13

效果:

    yarn add vuepress-theme-trx -D
    
    1
    npm install vuepress-theme-trx -D
    
    1
    // Make sure to add code blocks to your code group

    注意

    • 请在<code-group>标签与markdown内容之间使用空行隔开,否则可能会解析不出来。
    • 该组件只适用于放置代码块,放其他内容在体验上并不友好。如您确实需要放置其他内容的选项卡,推荐使用vuepress-plugin-tabs (opens new window)插件。
    Markdown使用教程
    提高文档表现力

    ← Markdown使用教程 提高文档表现力→

    Copyright © 2021-2022 用技术改变世界 | Tungray Cloud-Link
    • 跟随系统
    • 浅色模式
    • 深色模式
    • 阅读模式
    ×