useDocsRoute

判断当前路由是否是文档子页面,兼容默认语言的 /docs/* 与其他语言的 /{locale}/docs/*。自定义页头、页脚等全站组件需要只在文档页显示某些内容时使用。

useDocsRoute() 以当前语言的 docsRoot 为前缀判断路由。默认页头用它决定是否显示文档栏目条与阅读进度。

用法

app/components/FooterRight.vue
<script setup lang="ts">
const isDocsRoute = useDocsRoute()
</script>

<template>
  <span v-if="isDocsRoute">Docs</span>
</template>

签名

function useDocsRoute(): ComputedRef<boolean>

返回值

名称类型说明
(返回值本身)ComputedRef<boolean>当前路径以 ${docsRoot}/ 开头时为 true

注意事项

文档根路径本身(/docs)不以 /docs/ 开头,返回 false;它通常由重定向指向首篇文档。

更新日志

No recent changes
Copyright © 2024 - 2026