Function: useFrontmatter()

Source: 1.0.0-rc.14 · ecc10ae38a81 (uncommitted changes)

ts
function useFrontmatter<FM>(): ComputedRef<Partial<PostFrontMatter & FM>>;

Defined in: packages/valaxy/client/composables/common.ts:26

Get route.meta.frontmatter from your markdown file

Type Parameters

FM

FM extends Record<string, any>

Returns

ComputedRef<Partial<PostFrontMatter & FM>>

Example

md
---
title: Hello World
---
ts
const fm = useFrontmatter()
console.log(fm.value.title)

const fm = useFrontmatter<{ custom: string }>()
console.log(fm.value.custom)