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
{ "outlineTitle": "文章目录", "outline": [ 2, 6 ], "logo": "logo.jpg", "nav": [ { "text": "首页", "link": "/" }, { "text": "示例页", "link": "/markdown-examples" }, { "text": "点云", "link": "/point-cloud/" }, { "text": "深度学习", "link": "/deep-learning/" }, { "text": "Python", "items": [ { "text": "基础", "link": "/python/base/" }, { "text": "进阶", "link": "/python/advanced/" } ] } ], "sidebar": { "/point-cloud/": [ { "text": "点云侠", "collapsed": true, "items": [ { "text": "0.索引页", "link": "/point-cloud/点云侠/0.索引页.md" }, { "text": "Open3D KDTree的使用", "link": "/point-cloud/点云侠/Open3D KDTree的使用.md" }, { "text": "Open3D Mesh读写可视化", "link": "/point-cloud/点云侠/Open3D Mesh读写可视化.md" }, { "text": "Open3D Python版本快速安装和使用", "link": "/point-cloud/点云侠/Open3D Python版本快速安装和使用.md" }, { "text": "Open3D obj文件三维可视化", "link": "/point-cloud/点云侠/Open3D obj文件三维可视化.md" }, { "text": "Open3D 从体素网格构建八叉树", "link": "/point-cloud/点云侠/Open3D 从体素网格构建八叉树.md" }, { "text": "Open3D 从点云中构建八叉树", "link": "/point-cloud/点云侠/Open3D 从点云中构建八叉树.md" }, { "text": "Open3D 删除点云中重叠的点", "link": "/point-cloud/点云侠/Open3D 删除点云中重叠的点.md" }, { "text": "Open3D 点云的圆柱形邻域搜索", "link": "/point-cloud/点云侠/Open3D 点云的圆柱形邻域搜索.md" }, { "text": "Open3D 计算最近邻点的距离", "link": "/point-cloud/点云侠/Open3D 计算最近邻点的距离.md" }, { "text": "Open3D 计算点云平均密度(版本一)", "link": "/point-cloud/点云侠/Open3D 计算点云平均密度(版本一).md" }, { "text": "Open3D 计算点云平均密度(版本二)", "link": "/point-cloud/点云侠/Open3D 计算点云平均密度(版本二).md" }, { "text": "Open3D 计算点云的马氏距离", "link": "/point-cloud/点云侠/Open3D 计算点云的马氏距离.md" }, { "text": "Open3D 读取、保存、显示点云", "link": "/point-cloud/点云侠/Open3D 读取、保存、显示点云.md" }, { "text": "Open3D 读取、显示、保存图片", "link": "/point-cloud/点云侠/Open3D 读取、显示、保存图片.md" }, { "text": "Windows系统下python版本Open3D-0.18.0 的快速安装与使用", "link": "/point-cloud/点云侠/Windows系统下python版本Open3D-0.18.0 的快速安装与使用.md" } ] } ], "/python/base/": [ { "text": "function", "link": "/python/base//function.md" }, { "text": "if", "link": "/python/base//if.md" } ], "/python/advanced/": [ { "text": "0.目录", "link": "/python/advanced//0.目录.md" }, { "text": "lib", "link": "/python/advanced//lib.md" }, { "text": "object", "link": "/python/advanced//object.md" }, { "text": "yu", "collapsed": true, "items": [ { "text": "1", "link": "/python/advanced//yu/1.md" } ] } ], "/deep-learning/": [ { "text": "Part1-使用", "collapsed": true, "items": [ { "text": "00-预备知识", "link": "/deep-learning//Part1-使用/00-预备知识.md" } ] }, { "text": "Part2-张量", "collapsed": true, "items": [ { "text": "01-张量的创建和常用方法", "link": "/deep-learning//Part2-张量/01-张量的创建和常用方法.md" }, { "text": "02-张量的索引、分片、合并以及维度调整", "link": "/deep-learning//Part2-张量/02-张量的索引、分片、合并以及维度调整.md" }, { "text": "03-张量的广播和科学运算", "link": "/deep-learning//Part2-张量/03-张量的广播和科学运算.md" }, { "text": "04-张量的线性代数运算", "link": "/deep-learning//Part2-张量/04-张量的线性代数运算.md" } ] }, { "text": "Part3-优化", "collapsed": true, "items": [ { "text": "05.基本优化思想与最小二乘法", "link": "/deep-learning//Part3-优化/05.基本优化思想与最小二乘法.md" }, { "text": "06.动态计算图与梯度下降入门", "link": "/deep-learning//Part3-优化/06.动态计算图与梯度下降入门.md" } ] }, { "text": "Part4-神经网络", "collapsed": true, "items": [ { "text": "07.欢迎来到深度学习的世界", "link": "/deep-learning//Part4-神经网络/07.欢迎来到深度学习的世界.md" } ] } ] }, "socialLinks": [ { "icon": "github", "link": "https://github.com/vuejs/vitepress" } ], "footer": { "copyright": "Copyright@ 2024 羊鱼串" }, "search": { "provider": "local", "options": { "translations": { "button": { "buttonText": "搜索文档", "buttonAriaLabel": "搜索文档" }, "modal": { "noResultsText": "无法找到相关结果", "resetButtonTitle": "清除查询条件", "footer": { "selectText": "选择", "navigateText": "切换" } } } } } }
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.