作用描述

1、descriptioin 是站點(diǎn)的描述，
會被解析為 html 頁面的 <meta name="description" content ="xxx"> 標(biāo)簽 。

2、description 本身就是 <meta> 標(biāo)簽的一種，不會在頁面上展示出來，
僅僅是作為頁面的一個屬性存在。

補(bǔ)充- useData API 的作用

簡單理解 ： 這個方法可以獲取到頁面相關(guān)的一些數(shù)據(jù)。
本文會通過這個方法進(jìn)行 description 效果的一個驗(yàn)證。

案例

項(xiàng)目結(jié)構(gòu)

為了更好的理解項(xiàng)目，下面只展示相關(guān)的內(nèi)容。

projectName| -- .vitepress     # 項(xiàng)目配置相關(guān)的目錄| -- config.mts # 項(xiàng)目的配置文件| -- helloworld.md  # 本文用到的文檔

配置文件內(nèi)容

/*** 這是整個項(xiàng)目的配置文件*/
import { defineConfig } from 'vitepress'export default defineConfig({title: "體會description屬性",titleTemplate:false, // 取消標(biāo)題的后悔description: "對VitePress項(xiàng)目創(chuàng)建的簡單測試1",... 其他的項(xiàng)目配置})

文檔內(nèi)容

# 站點(diǎn)配置 - description 屬性站點(diǎn)的description ： {{ description }}<script setup>import { useData } from 'vitepress'const { description }= useData()
</script>

效果

至此，description 的作用與效果就展示完畢了。