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

{
  "logo": "https://download1324.mediafire.com/gamvaafru9uga7E5RTT8YaxqnibAWJMLPlReJJIjtks5qg1CLy-ae79FsBIajsu_Su568pS40gfslkV_BzzRM_JjTEe0yxPYH9LEdwZcQ1nSObBMemw5j_IRMVSC5RKI3NoOFz4X1y8H8kDBoVJrzLX-Gvfr3vsym60Cuf29_A/hz3r95akbb2f77z/5.webp",
  "nav": [
    {
      "text": "Home",
      "link": "/"
    },
    {
      "text": "Flashback Docs",
      "link": "/flashback/"
    },
    {
      "text": "Contact Me",
      "link": "/contact"
    }
  ],
  "search": {
    "provider": "local",
    "options": {}
  },
  "sidebar": {
    "/about/hobbies/games/minecraft/builds/": [
      {
        "text": "My Minecraft Builds",
        "items": [
          {
            "text": "About",
            "link": "./index"
          },
          {
            "text": "Bryce Canyon",
            "link": "./bryce-canyon"
          },
          {
            "text": "Chain Tree",
            "link": "./chain-tree"
          },
          {
            "text": "Builder's Refuge Solitary Competition",
            "link": "./br-comp-2024/"
          },
          {
            "text": "Norwegian Landscape Map",
            "link": "./norwegian-landscape"
          },
          {
            "text": "Oblivion Desert",
            "link": "./oblivion-desert"
          },
          {
            "text": "The Axiom",
            "link": "./the-axiom"
          }
        ]
      }
    ],
    "/about/hobbies/games/minecraft/builds/br-comp-2024/": [
      {
        "text": "Builder's Refuge Solitary Competition",
        "items": [
          {
            "text": "🡹 Return",
            "link": "./../"
          },
          {
            "text": "About",
            "link": "./index"
          },
          {
            "text": "Inspiration",
            "link": "./inspiration"
          },
          {
            "text": "References",
            "link": "./references"
          },
          {
            "text": "Build Process",
            "link": "./build-process"
          },
          {
            "text": "Easter Eggs",
            "link": "./easter-eggs"
          }
        ]
      }
    ],
    "/about/hobbies/games/minecraft/builds/norwegian-landscape/": [
      {
        "text": "Norwegian Landscape Map",
        "items": [
          {
            "text": "🡹 Return",
            "link": "./../"
          },
          {
            "text": "About",
            "link": "./index"
          },
          {
            "text": "Build Process",
            "link": "./build-process"
          },
          {
            "text": "Post Review",
            "link": "./post-review"
          }
        ]
      }
    ],
    "/about/hobbies/games/minecraft/builds/bryce-canyon/": [
      {
        "text": "Bryce Canyon (Incomplete)",
        "items": [
          {
            "text": "🡹 Return",
            "link": "./../"
          },
          {
            "text": "About",
            "link": "./index"
          },
          {
            "text": "References",
            "link": "./references"
          },
          {
            "text": "Build Process",
            "link": "./build-process"
          }
        ]
      }
    ],
    "/flashback/docs/": [
      {
        "text": "Flashback Documentation",
        "link": "/flashback/docs/",
        "items": [
          {
            "text": "Recording",
            "link": "/flashback/docs/recording/",
            "items": [
              {
                "text": "Configuration",
                "link": "/flashback/docs/recording/config"
              }
            ]
          },
          {
            "text": "Editor",
            "link": "/flashback/docs/editor/",
            "items": [
              {
                "text": "Timeline",
                "link": "/flashback/docs/editor/timeline/",
                "items": [
                  {
                    "text": "Elements",
                    "link": "/flashback/docs/editor/timeline/elements"
                  },
                  {
                    "text": "Keyframes",
                    "link": "/flashback/docs/editor/timeline/keyframes"
                  }
                ]
              },
              {
                "text": "Visuals",
                "link": "/flashback/docs/editor/visuals"
              },
              {
                "text": "Entity Options",
                "link": "/flashback/docs/editor/entityoptions"
              },
              {
                "text": "Exporting",
                "link": "/flashback/docs/editor/exporting"
              }
            ]
          }
        ]
      }
    ],
    "/about/": [
      {
        "text": "About WILLATRONIX",
        "items": [
          {
            "text": "Username",
            "link": "/about/username"
          },
          {
            "text": "Avatar",
            "link": "/about/avatar"
          }
        ]
      }
    ]
  },
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/WILLATRONIX/"
    }
  ]
}

Page Data

{
  "title": "Runtime API Examples",
  "description": "",
  "frontmatter": {
    "outline": "deep"
  },
  "headers": [],
  "relativePath": "api-examples.md",
  "filePath": "api-examples.md",
  "lastUpdated": 1719532881000
}

Page Frontmatter

{
  "outline": "deep"
}

More

Check out the documentation for the full list of runtime APIs.