Markdown 扩展

Kecare 在标准 Markdown 语法的基础上,提供了丰富的扩展功能,让你的文档更加生动和专业。

Front Matter

YAML Front Matter 开箱即用,你可以在文章开头添加元数据:

---
title: 写作指南
date: 2025-11-19
tags:
  - kecare
  - blog
desc: 这是一段简介
author: 作者
coverSrc: "https://example.com/cover.webp"
sticky: 1
menu: kecare-docs
translate: ['zh-CN', 'en-US', 'ja-JP']
---

这些数据将传递给主题组件,供页面使用。更多详情请参考 写作 文档。

代码块语法高亮

Kecare 使用 Shiki 实现代码块的语法高亮,支持多种编程语言。

基本用法

在代码块的起始反引号后添加语言标识:

```js
export default {
  name: 'MyComponent',
  data() {
    return {
      message: 'Hello Kecare!'
    }
  }
}
```

支持的语言

Shiki 支持几乎所有主流编程语言

代码块行高亮

你可以高亮代码块中的特定行,让读者更容易关注重点内容。

方式一:行号范围

在语言标识后添加 {行号}

```js{4}
export default {
  data () {
    return {
      msg: 'Highlighted!'  // 这一行会被高亮
    }
  }
}
```

高亮多行

支持多种格式组合:

格式 示例 说明
单行 {4} 高亮第 4 行
多个单行 {4,7,9} 高亮第 4、7、9 行
行范围 {5-8} 高亮第 5 到 8 行
混合使用 {4,7-13,16,23-27,40} 高亮多个行和范围

你也可以使用行内注释,在该行添加 // [!code highlight] 注释来实现高亮

效果展示

export default {
  data () {
    return {
      msg: 'Highlighted!'  //[!code highlight]
    }
  }
}

代码聚焦

使用聚焦功能可以让某一行突出显示,同时模糊其他行。 在目标行添加 // [!code focus] 注释:

效果展示

export default {
  data () {
    return {
      msg: 'Focused!' // [!code focus]
    }
  }
}

代码差异显示

在代码对比场景中,可以使用差异显示功能标记新增和删除的行。

在某一行添加 // [!code --]// [!code ++] 注释将会为该行创建 diff,同时保留代码块的颜色。

效果展示

export default {
  data () {
    return {
      msg: 'Removed' // [!code --]
      msg: 'Added' // [!code ++]
    }
  }
}

代码分组(Tabs)

你可以将多个代码块分组显示为标签页,方便切换查看。

基本用法

::: tabs

@tab js [config.js]

```js
/**
 * @type {import('vitepress').UserConfig}
 */
const config = {
  // ...
}

export default config
```

@tab ts [config.ts]

```ts
import type { UserConfig } from 'vitepress'

const config: UserConfig = {
  // ...
}

export default config
```

:::

效果展示

/**
 * @type {import('vitepress').UserConfig}
 */
const config = {
  // ...
}

export default config
文章作者:
文章链接:kecare.me/articles/b40d18d1
版权声明: 博客所有文章除特别声明外,均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来源