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": "Products",
      "link": "https://www.nimotion.com/product"
    },
    {
      "text": "Knowledge Base",
      "link": "IntegratedMotors/index.md"
    },
    {
      "text": "Case Studies",
      "link": "https://www.nimotion.com/solution"
    },
    {
      "text": "Contact",
      "link": "https://www.nimotion.com/contact"
    }
  ],
  "sidebar": [
    {
      "text": "Integrated Motors",
      "items": [
        {
          "text": "What is an integrated motor?",
          "link": "IntegratedMotors/index.md"
        },
        {
          "text": "Types of integrated motors",
          "link": "IntegratedMotorsTypes/index.md"
        },
        {
          "text": "The relationship between integrated motor and servo system",
          "link": "IntegratedMotorRelationship/index.md"
        },
        {
          "text": "Advantages and disadvantages of integrated motors",
          "link": "IntegratedMotorAdvantages/index.md"
        }
      ]
    },
    {
      "text": "Integrated Motor Selection Guide",
      "items": [
        {
          "text": "How to choose an integrated motor?",
          "link": "IntegratedMotorSelection/index.md"
        }
      ]
    },
    {
      "text": "Recommended models",
      "items": [
        {
          "text": "Recommended integrated motor models for small automation equipment",
          "link": "IntegratedMotorRecommended/index.md"
        }
      ]
    },
    {
      "text": "Motion Controller Special Topic",
      "items": [
        {
          "text": "Markdown Examples",
          "link": "/markdown-examples"
        },
        {
          "text": "Runtime API Examples",
          "link": "/api-examples"
        }
      ]
    }
  ]
}

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.