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:

<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": "Home",
      "link": "/"
    },
    {
      "text": "Documentación",
      "link": "/doc/"
    },
    {
      "text": "Examples",
      "link": "/markdown-examples"
    }
  ],
  "sidebar": {
    "/doc/": [
      {
        "text": "Overview",
        "items": [
          {
            "text": "Presentación",
            "link": "/"
          },
          {
            "text": "Créditos",
            "link": "/doc/00_Overview/credits"
          }
        ]
      },
      {
        "text": "Instalación",
        "items": [
          {
            "text": "Guía de instalación",
            "link": "/doc/01_install/install"
          }
        ]
      },
      {
        "text": "Imágenes base",
        "items": [
          {
            "text": "Pantallas",
            "link": "/doc/02_images/screens"
          },
          {
            "text": "Tutorial ZX Paintbrush",
            "link": "/doc/02_images/zx-paintbrush"
          },
          {
            "text": "Tileset",
            "link": "/doc/02_images/tileset"
          },
          {
            "text": "Spriteset",
            "link": "/doc/02_images/spriteset"
          },
          {
            "text": "Bala",
            "link": "/doc/02_images/bullet"
          }
        ]
      },
      {
        "text": "Diseñando el juego",
        "items": [
          {
            "text": "Introducción",
            "link": "/doc/03_tiled/overview"
          },
          {
            "text": "Configuración general",
            "link": "/doc/03_tiled/general-configuration"
          },
          {
            "text": "Crear el mapa",
            "link": "/doc/03_tiled/create-map"
          },
          {
            "text": "Preferencias",
            "link": "/doc/03_tiled/preferences"
          },
          {
            "text": "Tilesets",
            "link": "/doc/03_tiled/tilesets"
          },
          {
            "text": "Dibujando el mapa",
            "link": "/doc/03_tiled/drawing-map"
          },
          {
            "text": "Añadiendo enemigos",
            "link": "/doc/03_tiled/adding-enemies"
          },
          {
            "text": "Añadiendo objetos",
            "link": "/doc/03_tiled/adding-objects"
          },
          {
            "text": "Añadiendo plataformas móviles",
            "link": "/doc/03_tiled/adding-platforms"
          },
          {
            "text": "Arcade mode",
            "link": "/doc/03_tiled/arcade-mode"
          },
          {
            "text": "Traducir juego",
            "link": "/doc/03_tiled/localization"
          }
        ]
      },
      {
        "text": "Sonido",
        "items": [
          {
            "text": "Efectos FX",
            "link": "/doc/04_sound/fx"
          },
          {
            "text": "Música",
            "link": "/doc/04_sound/music"
          }
        ]
      },
      {
        "text": "Uso del motor",
        "items": [
          {
            "text": "Interfaz gráfica",
            "link": "/doc/05_engine/use"
          }
        ]
      },
      {
        "text": "Examples",
        "items": [
          {
            "text": "Markdown Examples",
            "link": "/markdown-examples"
          },
          {
            "text": "Runtime API Examples",
            "link": "/api-examples"
          }
        ]
      }
    ]
  },
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/vuejs/vitepress"
    }
  ]
}

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.