Runtime API Examples
This page demonstrates usage of some of the runtime APIs provided by VitePress.
The main useData() API can be used to access site, theme, and page data for the current page. It works in both .md and .vue files:
md
<script setup>
import { useData } from 'vitepress'
const { theme, page, frontmatter } = useData()
</script>
## Results
### Theme Data
<pre>{{ theme }}</pre>
### Page Data
<pre>{{ page }}</pre>
### Page Frontmatter
<pre>{{ frontmatter }}</pre>Results
Theme Data
{
"nav": [
{
"text": "Home",
"link": "/"
},
{
"text": "Examples",
"link": "/markdown-examples"
}
],
"sidebar": [
{
"text": "api-examples",
"link": "/api-examples"
},
{
"text": "markdown-examples",
"link": "/markdown-examples"
},
{
"text": "项目-集度",
"items": [
{
"text": "1.概述集度OTX代理插件",
"link": "/项目-集度/1.概述集度OTX代理插件"
},
{
"text": "10.envconfig多环境dev-test-staging-prod配置切换机制",
"link": "/项目-集度/10.envconfig多环境dev-test-staging-prod配置切换机制"
},
{
"text": "11.刷写器架构纵览从ecuflasher接口到ECU并行刷写的继承体系",
"link": "/项目-集度/11.刷写器架构纵览从ecuflasher接口到ECU并行刷写的继承体系"
},
{
"text": "12.ecuflashermanagerECU注册刷写文件绑定与优先级调度",
"link": "/项目-集度/12.ecuflashermanagerECU注册刷写文件绑定与优先级调度"
},
{
"text": "13.基于taskpool的多ECU并行刷写引擎",
"link": "/项目-集度/13.基于taskpool的多ECU并行刷写引擎"
},
{
"text": "14.基于mcd3d协议的doip文件下载与诊断通信",
"link": "/项目-集度/14.基于mcd3d协议的doip文件下载与诊断通信"
},
{
"text": "15.事件驱动模型刷写生命周期时间的发布与订阅机制",
"link": "/项目-集度/15.事件驱动模型刷写生命周期时间的发布与订阅机制"
},
{
"text": "16.顺序刷写与单ecu刷写模式",
"link": "/项目-集度/16.顺序刷写与单ecu刷写模式"
},
{
"text": "17.vbf文件解析器vbfheader-vbfblock与rsa签名验证",
"link": "/项目-集度/17.vbf文件解析器vbfheader-vbfblock与rsa签名验证"
},
{
"text": "18.不同格式刷写文件下载器",
"link": "/项目-集度/18.不同格式刷写文件下载器"
},
{
"text": "19.工位数据分块采集与结果汇总",
"link": "/项目-集度/19.工位数据分块采集与结果汇总"
},
{
"text": "2.快速上手构建与环境配置",
"link": "/项目-集度/2.快速上手构建与环境配置"
},
{
"text": "20.基于队列的异步报告传输机制",
"link": "/项目-集度/20.基于队列的异步报告传输机制"
},
{
"text": "21.报告数据模型与json序列化",
"link": "/项目-集度/21.报告数据模型与json序列化"
},
{
"text": "22.加密算法集aes-des-cbc-sha256-ecdsa-签名与base64编解码",
"link": "/项目-集度/22.加密算法集aes-des-cbc-sha256-ecdsa-签名与base64编解码"
},
{
"text": "23.证书管理p12解析OTA证书与ECU及安全常量获取",
"link": "/项目-集度/23.证书管理p12解析OTA证书与ECU及安全常量获取"
},
{
"text": "24.seedtokey-与-crc16诊断安全访问的密钥计算",
"link": "/项目-集度/24.seedtokey-与-crc16诊断安全访问的密钥计算"
},
{
"text": "25.分级日志系统",
"link": "/项目-集度/25.分级日志系统"
},
{
"text": "26.cbinary-高效二进制数据缓冲区操作类",
"link": "/项目-集度/26.cbinary-高效二进制数据缓冲区操作类"
},
{
"text": "27.mystringutils字符串处理与时间格式化工具",
"link": "/项目-集度/27.mystringutils字符串处理与时间格式化工具"
},
{
"text": "28.jidu_flasher-刷鞋任务编排硬件版本检查与fota状态跟踪",
"link": "/项目-集度/28.jidu_flasher-刷鞋任务编排硬件版本检查与fota状态跟踪"
},
{
"text": "29.dtc-故障码管理读取白名单过滤与掩码重载",
"link": "/项目-集度/29.dtc-故障码管理读取白名单过滤与掩码重载"
},
{
"text": "3.OTX运行时暴露的C语言API契约",
"link": "/项目-集度/3.OTX运行时暴露的C语言API契约"
},
{
"text": "30.车辆环境状态查询激活状态环境切换工单与软件版本升级路径",
"link": "/项目-集度/30.车辆环境状态查询激活状态环境切换工单与软件版本升级路径"
},
{
"text": "4.解析时间工具与日志系统的API实现",
"link": "/项目-集度/4.解析时间工具与日志系统的API实现"
},
{
"text": "5.与集度服务器的htttps双向认证通信客户端",
"link": "/项目-集度/5.与集度服务器的htttps双向认证通信客户端"
},
{
"text": "6.基于libcurl的http请求基类与证书管理",
"link": "/项目-集度/6.基于libcurl的http请求基类与证书管理"
},
{
"text": "7.callserver接口设计请求类型路由预处理后处理与脱敏机制",
"link": "/项目-集度/7.callserver接口设计请求类型路由预处理后处理与脱敏机制"
},
{
"text": "8.datacenter车辆订单安全常量证书信息的同缓存中心",
"link": "/项目-集度/8.datacenter车辆订单安全常量证书信息的同缓存中心"
},
{
"text": "9.cvehicleconfig整车软件包配置解析与刷写文件匹配策略",
"link": "/项目-集度/9.cvehicleconfig整车软件包配置解析与刷写文件匹配策略"
}
]
}
],
"socialLinks": [
{
"icon": "github",
"link": "https://github.com/ZhanXiaoHuai/Knowledge"
}
]
}Page Data
{
"title": "Runtime API Examples",
"description": "",
"frontmatter": {
"outline": "deep"
},
"headers": [],
"relativePath": "api-examples.md",
"filePath": "api-examples.md"
}Page Frontmatter
{
"outline": "deep"
}More
Check out the documentation for the full list of runtime APIs.