vitepress icon indicating copy to clipboard operation
vitepress copied to clipboard

improve developer experience for default-empty 'headers' field in PageData

Open indirectlylit opened this issue 1 year ago • 1 comments

Is your feature request related to a problem? Please describe.

page.headers as returned from useData was an empty array even though my document had headers defined. It took my some searching to understand that I needed to set the following config in order to populate it:

  markdown: {
    headers: true,
  },

This issue – where the user had the same confusion – helped me understand: https://github.com/vuejs/vitepress/issues/2840#issuecomment-1691067613

Describe the solution you'd like

Two things might help

  1. add documentation which connects https://vitepress.dev/reference/runtime-api#usedata to https://vitepress.dev/reference/site-config
  2. make headers optional, and don't include it when not enabled ([] vs undefined)

Describe alternatives you've considered

possibly enable headers by default

Additional context

No response

Validations

indirectlylit avatar Nov 14 '23 20:11 indirectlylit