Appearance
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": "前端",
"items": [
{
"text": "Flutter",
"link": "http://book.anysome.cn/flutter/",
"target": "_blank"
},
{
"text": "Html",
"link": "http://book.anysome.cn/html/",
"target": "_blank"
},
{
"text": "Css",
"link": "http://book.anysome.cn/css/",
"target": "_blank"
},
{
"text": "Css3",
"link": "http://book.anysome.cn/css3/",
"target": "_blank"
},
{
"text": "TypeScript",
"link": "http://book.anysome.cn/ts/",
"target": "_blank"
},
{
"text": "JavaScript",
"link": "http://book.anysome.cn/js/",
"target": "_blank"
}
]
},
{
"text": "服务端",
"items": [
{
"text": "C",
"link": "http://book.anysome.cn/c/",
"target": "_blank"
},
{
"text": "C++",
"link": "http://book.anysome.cn/cpp/",
"target": "_blank"
},
{
"text": "Java",
"link": "http://book.anysome.cn/java/",
"target": "_blank"
},
{
"text": "Java设计模式",
"link": "http://book.anysome.cn/dp/",
"target": "_blank"
},
{
"text": "Python3",
"link": "http://book.anysome.cn/python/",
"target": "_blank"
},
{
"text": "Golang",
"link": "http://book.anysome.cn/go/",
"target": "_blank"
},
{
"text": "Rust",
"link": "http://book.anysome.cn/rust/",
"target": "_blank"
},
{
"text": "Sql",
"link": "http://book.anysome.cn/sql/",
"target": "_blank"
},
{
"text": "Lua",
"link": "http://book.anysome.cn/lua/",
"target": "_blank"
},
{
"text": "Shell",
"link": "http://book.anysome.cn/shell/",
"target": "_blank"
}
]
},
{
"text": "中间件",
"items": [
{
"text": "mysql",
"link": "http://book.anysome.cn/mysql/",
"target": "_blank"
},
{
"text": "mongodb",
"link": "http://book.anysome.cn/mongodb/",
"target": "_blank"
},
{
"text": "elasticSearch",
"link": "http://book.anysome.cn/elasticSearch/",
"target": "_blank"
},
{
"text": "docker",
"link": "http://book.anysome.cn/docker/",
"target": "_blank"
},
{
"text": "nginx",
"link": "http://book.anysome.cn/nginx/",
"target": "_blank"
},
{
"text": "Qdrant",
"link": "http://book.anysome.cn/qdrant/",
"target": "_blank"
}
]
},
{
"text": "工具",
"items": [
{
"text": "Git",
"link": "http://book.anysome.cn/git/",
"target": "_blank"
},
{
"text": "Maven",
"link": "http://book.anysome.cn/maven/",
"target": "_blank"
},
{
"text": "Gradle",
"link": "http://book.anysome.cn/gradle/",
"target": "_blank"
},
{
"text": "Markdown",
"link": "http://book.anysome.cn/markdown/",
"target": "_blank"
}
]
},
{
"text": "AI",
"items": [
{
"text": "AI",
"link": "http://book.anysome.cn/ai/",
"target": "_blank"
}
]
},
{
"text": "知识库",
"items": [
{
"text": "备忘录",
"link": "/备忘录/git"
},
{
"text": "网站推荐",
"link": "/网站推荐/README"
},
{
"text": "Shell脚本",
"link": "/脚本/shell/http心跳检测"
},
{
"text": "Python脚本",
"link": "/脚本/python/SSH客户端"
}
]
}
],
"sidebar": {
"/备忘录": {
"items": [
{
"text": "版本控制",
"items": [
{
"text": "Git 常用命令",
"link": "/备忘录/git"
}
]
},
{
"text": "构建工具",
"items": [
{
"text": "Maven核心概念总结",
"link": "/备忘录/maven"
},
{
"text": "Gradle核心概念总结",
"link": "/备忘录/gradle"
},
{
"text": "Cargo 常用命令",
"link": "/备忘录/cargo"
}
]
},
{
"text": "语言版本管理",
"items": [
{
"text": "pyenv 教程",
"link": "/备忘录/pyenv"
},
{
"text": "jenv 教程",
"link": "/备忘录/jenv"
},
{
"text": "nvm 教程",
"link": "/备忘录/nvm"
}
]
},
{
"text": "服务器管理",
"items": [
{
"text": "SSH 常用命令",
"link": "/备忘录/ssh"
},
{
"text": "Nginx 配置指南",
"link": "/备忘录/nginx"
},
{
"text": "PM2 进程管理",
"link": "/备忘录/pm2"
}
]
},
{
"text": "文本处理",
"items": [
{
"text": "Grep 命令详解",
"link": "/备忘录/grep"
}
]
}
]
},
"/网站推荐": {
"items": [
{
"text": "前端开发",
"items": [
{
"text": "CSS 动效",
"link": "/网站推荐/CSS动效"
},
{
"text": "图标库",
"link": "/网站推荐/图标库"
},
{
"text": "渐变与背景",
"link": "/网站推荐/渐变背景"
},
{
"text": "在线工具",
"link": "/网站推荐/在线工具"
}
]
},
{
"text": "设计",
"items": [
{
"text": "UI 设计",
"link": "/网站推荐/UI设计"
},
{
"text": "图片与插画",
"link": "/网站推荐/图片插画"
},
{
"text": "字体资源",
"link": "/网站推荐/字体"
},
{
"text": "3D 素材",
"link": "/网站推荐/3D素材"
}
]
},
{
"text": "AI 工具",
"items": [
{
"text": "AI 对话",
"link": "/网站推荐/AI对话"
},
{
"text": "AI 生图",
"link": "/网站推荐/AI生图"
},
{
"text": "AI 编程",
"link": "/网站推荐/AI编程"
},
{
"text": "AI 效率工具",
"link": "/网站推荐/AI效率工具"
}
]
},
{
"text": "学习资源",
"items": [
{
"text": "学习资源",
"link": "/网站推荐/学习资源"
},
{
"text": "技术博客",
"link": "/网站推荐/技术博客"
}
]
},
{
"text": "部署与运维",
"items": [
{
"text": "托管平台",
"link": "/网站推荐/托管平台"
},
{
"text": "监控与性能",
"link": "/网站推荐/监控性能"
}
]
}
]
},
"/脚本/shell": {
"items": [
{
"text": "系统监控",
"items": [
{
"text": "http心跳检测",
"link": "/脚本/shell/http心跳检测"
},
{
"text": "zabbix监控用户密码过期",
"link": "/脚本/shell/zabbix监控用户密码过期"
},
{
"text": "内存检测",
"link": "/脚本/shell/内存检测"
},
{
"text": "批量检测网站是否异常并邮件通知",
"link": "/脚本/shell/批量检测网站是否异常并邮件通知"
},
{
"text": "找出占用CPU内存过高的进程",
"link": "/脚本/shell/找出占用CPU内存过高的进程"
},
{
"text": "查看网卡实时流量",
"link": "/脚本/shell/查看网卡实时流量"
},
{
"text": "检测CPU剩余百分比",
"link": "/脚本/shell/检测CPU剩余百分比"
},
{
"text": "检测两台服务器指定目录下的文件一致性",
"link": "/脚本/shell/检测两台服务器指定目录下的文件一致性"
},
{
"text": "检测磁盘剩余空间",
"link": "/脚本/shell/检测磁盘剩余空间"
},
{
"text": "检测网卡流量并记录",
"link": "/脚本/shell/检测网卡流量并记录"
},
{
"text": "监控httpd的进程数",
"link": "/脚本/shell/监控httpd的进程数"
},
{
"text": "监控MySQL主从同步状态是否异常脚本",
"link": "/脚本/shell/监控MySQL主从同步状态是否异常脚本"
},
{
"text": "监控多台服务器磁盘利用率脚本",
"link": "/脚本/shell/监控多台服务器磁盘利用率脚本"
},
{
"text": "监控机器分区使用率并发邮件",
"link": "/脚本/shell/监控机器分区使用率并发邮件"
},
{
"text": "监控机器空间使用率并发送邮件",
"link": "/脚本/shell/监控机器空间使用率并发送邮件"
},
{
"text": "目录入侵检测与告警",
"link": "/脚本/shell/目录入侵检测与告警"
},
{
"text": "统计Linux进程相关数量信息",
"link": "/脚本/shell/统计Linux进程相关数量信息"
},
{
"text": "轮询检测Apache状态并启用钉钉报警",
"link": "/脚本/shell/轮询检测Apache状态并启用钉钉报警"
}
]
},
{
"text": "数据库管理",
"items": [
{
"text": "MySQL数据库备份单循环",
"link": "/脚本/shell/MySQL数据库备份单循环"
},
{
"text": "MySQL数据库备份多循环",
"link": "/脚本/shell/MySQL数据库备份多循环"
},
{
"text": "MySql数据库备份脚本(分表备份)",
"link": "/脚本/shell/MySql数据库备份脚本(分表备份)"
},
{
"text": "MySql数据库备份脚本",
"link": "/脚本/shell/MySql数据库备份脚本"
},
{
"text": "备份数据库目录脚本",
"link": "/脚本/shell/备份数据库目录脚本"
},
{
"text": "每天自动备份MySQL数据库",
"link": "/脚本/shell/每天自动备份MySQL数据库"
}
]
},
{
"text": "服务器管理",
"items": [
{
"text": "一键安装MongoDB",
"link": "/脚本/shell/一键安装MongoDB"
},
{
"text": "一键安装tomcat脚本",
"link": "/脚本/shell/一键安装tomcat脚本"
},
{
"text": "一键查看服务器利用率",
"link": "/脚本/shell/一键查看服务器利用率"
},
{
"text": "一键编译安装Redis脚本",
"link": "/脚本/shell/一键编译安装Redis脚本"
},
{
"text": "从FTP服务器下载文件",
"link": "/脚本/shell/从FTP服务器下载文件"
},
{
"text": "判断哪些用户登陆了系统",
"link": "/脚本/shell/判断哪些用户登陆了系统"
},
{
"text": "判断用户输入的是否为IP地址",
"link": "/脚本/shell/判断用户输入的是否为IP地址"
},
{
"text": "扫描主机端口状态",
"link": "/脚本/shell/扫描主机端口状态"
},
{
"text": "批量主机远程执行命令脚本",
"link": "/脚本/shell/批量主机远程执行命令脚本"
},
{
"text": "批量修改服务器用户密码",
"link": "/脚本/shell/批量修改服务器用户密码"
},
{
"text": "服务器系统配置初始化",
"link": "/脚本/shell/服务器系统配置初始化"
},
{
"text": "自动安装",
"link": "/脚本/shell/自动安装"
}
]
},
{
"text": "安全防护",
"items": [
{
"text": "Dos攻击防范",
"link": "/脚本/shell/Dos攻击防范"
},
{
"text": "Linux系统发送告警脚本",
"link": "/脚本/shell/Linux系统发送告警脚本"
},
{
"text": "PV过量自动实现防火墙封IP",
"link": "/脚本/shell/PV过量自动实现防火墙封IP"
},
{
"text": "封禁请求量异常的IP",
"link": "/脚本/shell/封禁请求量异常的IP"
},
{
"text": "屏蔽每分钟SSH尝试登录超过10次的IP",
"link": "/脚本/shell/屏蔽每分钟SSH尝试登录超过10次的IP"
},
{
"text": "屏蔽每分钟访问超过200的IP",
"link": "/脚本/shell/屏蔽每分钟访问超过200的IP"
}
]
},
{
"text": "日志处理",
"items": [
{
"text": "Nginx日志按要求切割",
"link": "/脚本/shell/Nginx日志按要求切割"
},
{
"text": "Nginx访问日志分析脚本",
"link": "/脚本/shell/Nginx访问日志分析脚本"
},
{
"text": "Nginx访问日志自动按天(周月)切割",
"link": "/脚本/shell/Nginx访问日志自动按天(周月)切割"
},
{
"text": "Nginx访问访问日志按天切割",
"link": "/脚本/shell/Nginx访问访问日志按天切割"
},
{
"text": "监测Nginx访问日志502情况",
"link": "/脚本/shell/监测Nginx访问日志502情况"
}
]
},
{
"text": "自动化部署",
"items": [
{
"text": "一键申请多个证书shell脚本",
"link": "/脚本/shell/一键申请多个证书shell脚本"
},
{
"text": "一键证书申请和颁发脚本",
"link": "/脚本/shell/一键证书申请和颁发脚本"
},
{
"text": "一键部署LNMP网站平台脚本",
"link": "/脚本/shell/一键部署LNMP网站平台脚本"
},
{
"text": "自动ftp上传",
"link": "/脚本/shell/自动ftp上传"
},
{
"text": "自动创建文件",
"link": "/脚本/shell/自动创建文件"
},
{
"text": "自动发布Java项目(Tomcat)",
"link": "/脚本/shell/自动发布Java项目(Tomcat)"
}
]
},
{
"text": "实用工具",
"items": [
{
"text": "SVN完整备份",
"link": "/脚本/shell/SVN完整备份"
},
{
"text": "修改文件后缀",
"link": "/脚本/shell/修改文件后缀"
},
{
"text": "备份当前日期文件",
"link": "/脚本/shell/备份当前日期文件"
},
{
"text": "定时清空文件内容",
"link": "/脚本/shell/定时清空文件内容"
},
{
"text": "实现动态进度条",
"link": "/脚本/shell/实现动态进度条"
},
{
"text": "并发从数台机器中获取hostname",
"link": "/脚本/shell/并发从数台机器中获取hostname"
},
{
"text": "批量修改文件名",
"link": "/脚本/shell/批量修改文件名"
},
{
"text": "杀死所有脚本",
"link": "/脚本/shell/杀死所有脚本"
},
{
"text": "构建本地YUM",
"link": "/脚本/shell/构建本地YUM"
},
{
"text": "查看某个端口下请求数最多的ip",
"link": "/脚本/shell/查看某个端口下请求数最多的ip"
},
{
"text": "生成随机数",
"link": "/脚本/shell/生成随机数"
},
{
"text": "移动文件",
"link": "/脚本/shell/移动文件"
},
{
"text": "统计gc信息",
"link": "/脚本/shell/统计gc信息"
},
{
"text": "统计指定文件类型的总大小",
"link": "/脚本/shell/统计指定文件类型的总大小"
},
{
"text": "计算文档每行出现的数字个数",
"link": "/脚本/shell/计算文档每行出现的数字个数"
}
]
}
]
},
"/脚本/python": {
"items": [
{
"text": "网络客户端",
"items": [
{
"text": "SSH客户端",
"link": "/脚本/python/SSH客户端"
},
{
"text": "FTP上传下载",
"link": "/脚本/python/FTP上传下载"
}
]
},
{
"text": "系统管理",
"items": [
{
"text": "Saltstack客户端",
"link": "/脚本/python/Saltstack客户端"
},
{
"text": "vCenter进行日常操作",
"link": "/脚本/python/vCenter进行日常操作"
}
]
},
{
"text": "安全检测",
"items": [
{
"text": "获取域名ssl证书过期时间",
"link": "/脚本/python/获取域名ssl证书过期时间"
}
]
}
]
}
},
"footer": {
"copyright": "Copyright © 2025-2026 京公网安备 11010102000001号 京ICP备2024078128号-1"
}
}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.