API 文档

本页面展示了 VitePress 提供的部分运行时 API 的使用方法。

核心的 useData() API 可用于获取当前页面的站点、主题以及页面数据。它在 .md 和 .vue 文件中均可正常工作：

<script setup>
import { useData } from 'vitepress'

const { theme, page, frontmatter } = useData()
</script>

## 渲染结果

### 主题数据
<pre>{{ theme }}</pre>

### 页面数据
<pre>{{ page }}</pre>

### 页面 Frontmatter
<pre>{{ frontmatter }}</pre>

渲染结果

主题数据

{
  "docFooter": {
    "prev": false,
    "next": false
  },
  "aside": false,
  "nav": [
    {
      "text": "GIT 常用操作",
      "link": "/1.默认分类/5.%20git常用操作.html"
    },
    {
      "text": "Debian 初始化",
      "link": "/1.默认分类/1.%20Debian%20LXC.html"
    },
    {
      "text": "Gemini",
      "link": "https://gemini.google.com/app"
    }
  ],
  "footer": {
    "message": "基于 Vitepress.",
    "copyright": "Copyright © 2026"
  },
  "sidebar": [
    {
      "text": "1.默认分类",
      "items": [
        {
          "text": "0. 添加minica根证书",
          "link": "/1.默认分类/0. minica"
        },
        {
          "text": "1. Debian lxc初始化",
          "link": "/1.默认分类/1. Debian LXC"
        },
        {
          "text": "2. Centos 初始化",
          "link": "/1.默认分类/2. Centos初始化"
        },
        {
          "text": "3. Linux日志配置",
          "link": "/1.默认分类/3. Linux日志相关配置"
        },
        {
          "text": "5. git常用操作",
          "link": "/1.默认分类/5. git常用操作"
        },
        {
          "text": "6. .gitignore",
          "link": "/1.默认分类/6. git ignore"
        },
        {
          "text": "7. mysql 主从同步",
          "link": "/1.默认分类/7. mysql主从同步"
        },
        {
          "text": "8. publickeys",
          "link": "/1.默认分类/8. publickeys"
        },
        {
          "text": "9. macos常用命令",
          "link": "/1.默认分类/9. macos常用命令"
        },
        {
          "text": "10. tmux 命令文档",
          "link": "/1.默认分类/10. tmux"
        },
        {
          "text": "11. 📘 Git 命令手册（完整版）",
          "link": "/1.默认分类/11. git"
        },
        {
          "text": "12. linux 常用命令",
          "link": "/1.默认分类/12.linux 常用命令"
        },
        {
          "text": "13. gitea runner配置",
          "link": "/1.默认分类/13. gitea runner配置"
        }
      ],
      "collapsed": true
    },
    {
      "text": "2.星运",
      "items": [
        {
          "text": "1. 主机资料",
          "link": "/2.星运/1.主从"
        },
        {
          "text": "2. 主机资料-已删除",
          "link": "/2.星运/2. 旧主机"
        },
        {
          "text": "3. RSG转账钱包",
          "link": "/2.星运/3.RSG"
        },
        {
          "text": "4. ATG",
          "link": "/2.星运/4.ATG"
        },
        {
          "text": "5. DS",
          "link": "/2.星运/5. DS"
        }
      ],
      "collapsed": true
    },
    {
      "text": "3.富爸爸",
      "items": [
        {
          "text": "正式主机",
          "link": "/3.富爸爸/1.主机"
        }
      ],
      "collapsed": true
    },
    {
      "text": "4. yg5858",
      "items": [
        {
          "text": "1. RSG",
          "link": "/4. yg5858/1. RSG"
        },
        {
          "text": "2. ATG",
          "link": "/4. yg5858/2. ATG"
        }
      ],
      "collapsed": true
    },
    {
      "text": "5.GCP",
      "items": [
        {
          "text": "1. JP Slot 推流主機",
          "link": "/5.GCP/1.jpslot-srs"
        }
      ],
      "collapsed": true
    },
    {
      "text": "6. ca5888 九龙",
      "items": [
        {
          "text": "1. RSG",
          "link": "/6. ca5888 九龙/1. RSG"
        },
        {
          "text": "2. RP后台",
          "link": "/6. ca5888 九龙/2. RP"
        },
        {
          "text": "3. SQL",
          "link": "/6. ca5888 九龙/3. sql"
        }
      ],
      "collapsed": true
    },
    {
      "text": "7. joker-slot",
      "items": [
        {
          "text": "1. 站点配置",
          "link": "/7. joker-slot/1. 站点配置"
        }
      ],
      "collapsed": true
    },
    {
      "text": "99999.文档",
      "items": [
        {
          "text": "API 文档",
          "link": "/99999.文档/API"
        },
        {
          "text": "Markdown 扩展",
          "link": "/99999.文档/markdown-examples"
        }
      ],
      "collapsed": true
    },
    {
      "text": "Proxy",
      "items": [
        {
          "text": "Jet",
          "link": "/proxy/jet"
        }
      ],
      "collapsed": true
    },
    {
      "text": "文档",
      "items": [
        {
          "text": "API 文档",
          "link": "/文档/API"
        },
        {
          "text": "Markdown 扩展",
          "link": "/文档/markdown-examples"
        }
      ],
      "collapsed": true
    },
    {
      "text": "翻墙",
      "items": [
        {
          "text": "1. Debian vless",
          "link": "/翻墙/1. Debian vless"
        },
        {
          "text": "2. Centos vless",
          "link": "/翻墙/2. Centos vless"
        },
        {
          "text": "3. ss配置",
          "link": "/翻墙/3. ss配置"
        },
        {
          "text": "4. 防火墙",
          "link": "/翻墙/4. 防火墙"
        }
      ],
      "collapsed": true
    },
    {
      "text": "银河",
      "link": "/银河"
    }
  ]
}

页面数据

{
  "title": "API 文档",
  "description": "",
  "frontmatter": {
    "outline": "deep"
  },
  "headers": [],
  "relativePath": "文档/API.md",
  "filePath": "文档/API.md"
}

页面 Frontmatter

{
  "outline": "deep"
}

更多参考

请查阅官方文档以获取 运行时 API 的完整列表。