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

{
  "outlineTitle": "Table of Contents",
  "outline": [
    2,
    6
  ],
  "logo": "/logo/logo.svg",
  "nav": [
    {
      "text": "首页",
      "link": "/"
    },
    {
      "text": "示例",
      "items": [
        {
          "text": "Markdown Examples",
          "link": "/view/examples/markdown-examples"
        },
        {
          "text": "Runtime API Examples",
          "link": "/view/examples/api-examples"
        }
      ]
    },
    {
      "text": "mock1",
      "items": [
        {
          "text": "mock1 Examples",
          "link": "/view/mock1/Basic Syntax"
        },
        {
          "text": "mock1 API Examples",
          "link": "/view/mock1/Extended Syntax"
        }
      ]
    },
    {
      "text": "mock2",
      "items": [
        {
          "text": "mock2 Examples",
          "link": "/view/mock2/Getting Started"
        },
        {
          "text": "mock2 API Examples",
          "link": "/view/mock2/Markdown 基本语法"
        }
      ]
    }
  ],
  "sidebar": {
    "/view/examples": [
      {
        "text": "api-examples",
        "collapsed": false,
        "link": "view/examples/api-examples.md"
      },
      {
        "text": "markdown-examples",
        "collapsed": false,
        "link": "view/examples/markdown-examples.md"
      }
    ],
    "/view/mock1": [
      {
        "text": "Basic Syntax",
        "collapsed": false,
        "link": "view/mock1/Basic Syntax.md"
      },
      {
        "text": "Extended Syntax",
        "collapsed": false,
        "link": "view/mock1/Extended Syntax.md"
      },
      {
        "text": "Getting Started",
        "collapsed": false,
        "link": "view/mock1/Getting Started.md"
      },
      {
        "text": "Markdown Cheat Sheet",
        "collapsed": false,
        "link": "view/mock1/Markdown Cheat Sheet.md"
      },
      {
        "text": "Markdown 基本语法",
        "collapsed": false,
        "link": "view/mock1/Markdown 基本语法.md"
      },
      {
        "text": "README",
        "collapsed": false,
        "link": "view/mock1/README.md"
      },
      {
        "text": "test1",
        "collapsed": false,
        "items": [
          {
            "text": "Markdown 入门指南",
            "collapsed": false,
            "link": "view/mock1/test1/Markdown 入门指南.md"
          },
          {
            "text": "Markdown 扩展语法",
            "collapsed": false,
            "link": "view/mock1/test1/Markdown 扩展语法.md"
          },
          {
            "text": "Markdown 语法速查表",
            "collapsed": false,
            "link": "view/mock1/test1/Markdown 语法速查表.md"
          }
        ]
      }
    ],
    "/view/mock2": [
      {
        "text": "Basic Syntax",
        "collapsed": false,
        "link": "view/mock2/Basic Syntax.md"
      },
      {
        "text": "Extended Syntax",
        "collapsed": false,
        "link": "view/mock2/Extended Syntax.md"
      },
      {
        "text": "Getting Started",
        "collapsed": false,
        "link": "view/mock2/Getting Started.md"
      },
      {
        "text": "Markdown Cheat Sheet",
        "collapsed": false,
        "link": "view/mock2/Markdown Cheat Sheet.md"
      },
      {
        "text": "Markdown 入门指南",
        "collapsed": false,
        "link": "view/mock2/Markdown 入门指南.md"
      },
      {
        "text": "Markdown 基本语法",
        "collapsed": false,
        "link": "view/mock2/Markdown 基本语法.md"
      },
      {
        "text": "Markdown 扩展语法",
        "collapsed": false,
        "link": "view/mock2/Markdown 扩展语法.md"
      },
      {
        "text": "Markdown 语法速查表",
        "collapsed": false,
        "link": "view/mock2/Markdown 语法速查表.md"
      },
      {
        "text": "README",
        "collapsed": false,
        "link": "view/mock2/README.md"
      }
    ],
    "/view/mock3": [
      {
        "text": "Basic Syntax",
        "collapsed": false,
        "link": "view/mock3/Basic Syntax.md"
      },
      {
        "text": "Extended Syntax",
        "collapsed": false,
        "link": "view/mock3/Extended Syntax.md"
      },
      {
        "text": "Getting Started",
        "collapsed": false,
        "link": "view/mock3/Getting Started.md"
      },
      {
        "text": "Markdown Cheat Sheet",
        "collapsed": false,
        "link": "view/mock3/Markdown Cheat Sheet.md"
      },
      {
        "text": "Markdown 入门指南",
        "collapsed": false,
        "link": "view/mock3/Markdown 入门指南.md"
      },
      {
        "text": "Markdown 基本语法",
        "collapsed": false,
        "link": "view/mock3/Markdown 基本语法.md"
      },
      {
        "text": "Markdown 扩展语法",
        "collapsed": false,
        "link": "view/mock3/Markdown 扩展语法.md"
      },
      {
        "text": "Markdown 语法速查表",
        "collapsed": false,
        "link": "view/mock3/Markdown 语法速查表.md"
      },
      {
        "text": "README",
        "collapsed": false,
        "link": "view/mock3/README.md"
      }
    ],
    "/view/mock4": [
      {
        "text": "Basic Syntax",
        "collapsed": false,
        "link": "view/mock4/Basic Syntax.md"
      },
      {
        "text": "Extended Syntax",
        "collapsed": false,
        "link": "view/mock4/Extended Syntax.md"
      },
      {
        "text": "Getting Started",
        "collapsed": false,
        "link": "view/mock4/Getting Started.md"
      },
      {
        "text": "Markdown Cheat Sheet",
        "collapsed": false,
        "link": "view/mock4/Markdown Cheat Sheet.md"
      },
      {
        "text": "Markdown 入门指南",
        "collapsed": false,
        "link": "view/mock4/Markdown 入门指南.md"
      },
      {
        "text": "Markdown 基本语法",
        "collapsed": false,
        "link": "view/mock4/Markdown 基本语法.md"
      },
      {
        "text": "Markdown 扩展语法",
        "collapsed": false,
        "link": "view/mock4/Markdown 扩展语法.md"
      },
      {
        "text": "Markdown 语法速查表",
        "collapsed": false,
        "link": "view/mock4/Markdown 语法速查表.md"
      },
      {
        "text": "README",
        "collapsed": false,
        "link": "view/mock4/README.md"
      }
    ]
  },
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/vuejs/vitepress"
    }
  ],
  "footer": {
    "copyright": "Copyright@ 2024 your company"
  },
  "search": {
    "provider": "local",
    "options": {}
  }
}

Page Data

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

Page Frontmatter

{
  "outline": "deep"
}

More

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