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": "Kurse",
      "link": "/kurse/"
    }
  ],
  "sidebar": {
    "/kurse/": [
      {
        "text": "Mathe 2",
        "collapsed": true,
        "items": [
          {
            "text": "Übersicht",
            "link": "/kurse/mathe-2/"
          },
          {
            "text": "Vorlesungen",
            "items": [
              {
                "text": "Übersicht",
                "link": "/kurse/mathe-2/vorlesungen/"
              },
              {
                "text": "3 Lineare Algebra",
                "collapsed": true,
                "items": [
                  {
                    "text": "Übersicht",
                    "link": "/kurse/mathe-2/vorlesungen/lineare-algebra/"
                  },
                  {
                    "text": "3.1 Vektorräume",
                    "link": "/kurse/mathe-2/vorlesungen/lineare-algebra/1"
                  },
                  {
                    "text": "3.2 Linearkombination, Basis, Dimension",
                    "link": "/kurse/mathe-2/vorlesungen/lineare-algebra/2"
                  },
                  {
                    "text": "3.3 Normierte Räume",
                    "link": "/kurse/mathe-2/vorlesungen/lineare-algebra/3"
                  },
                  {
                    "text": "3.4 Geometrie im ℝⁿ",
                    "link": "/kurse/mathe-2/vorlesungen/lineare-algebra/4"
                  },
                  {
                    "text": "3.5 Lineare Abbildungen",
                    "link": "/kurse/mathe-2/vorlesungen/lineare-algebra/5"
                  },
                  {
                    "text": "3.6 Matrizen und lineare Abbildungen",
                    "link": "/kurse/mathe-2/vorlesungen/lineare-algebra/6"
                  },
                  {
                    "text": "3.7 Lineare Gleichungssysteme (LGS)",
                    "link": "/kurse/mathe-2/vorlesungen/lineare-algebra/7"
                  },
                  {
                    "text": "3.8 Lineare Optimierung",
                    "link": "/kurse/mathe-2/vorlesungen/lineare-algebra/8"
                  },
                  {
                    "text": "3.9 Determinanten",
                    "link": "/kurse/mathe-2/vorlesungen/lineare-algebra/9"
                  },
                  {
                    "text": "3.10 Eigenwerte",
                    "link": "/kurse/mathe-2/vorlesungen/lineare-algebra/10"
                  }
                ]
              },
              {
                "text": "4 Analysis I",
                "collapsed": true,
                "items": [
                  {
                    "text": "Übersicht",
                    "link": "/kurse/mathe-2/vorlesungen/analysis-1/"
                  },
                  {
                    "text": "4.1 Die reellen Zahlen",
                    "link": "/kurse/mathe-2/vorlesungen/analysis-1/1"
                  },
                  {
                    "text": "4.2 Wurzeln, Fakultäten, Binomialkoeffizienten",
                    "link": "/kurse/mathe-2/vorlesungen/analysis-1/2"
                  },
                  {
                    "text": "4.3 Konvergenz von Folgen",
                    "link": "/kurse/mathe-2/vorlesungen/analysis-1/3"
                  },
                  {
                    "text": "4.4 Asymptotik",
                    "link": "/kurse/mathe-2/vorlesungen/analysis-1/4"
                  },
                  {
                    "text": "4.5 Die Master-Methode",
                    "link": "/kurse/mathe-2/vorlesungen/analysis-1/5"
                  },
                  {
                    "text": "4.6 Stetigkeit reeller Funktionen",
                    "link": "/kurse/mathe-2/vorlesungen/analysis-1/6"
                  },
                  {
                    "text": "4.7 Wichtige Funktionen",
                    "link": "/kurse/mathe-2/vorlesungen/analysis-1/7"
                  }
                ]
              },
              {
                "text": "5 Analysis II",
                "collapsed": true,
                "items": [
                  {
                    "text": "Übersicht",
                    "link": "/kurse/mathe-2/vorlesungen/analysis-2/"
                  },
                  {
                    "text": "5.1 Differenzierbarkeit von Funktionen in einer Variablen",
                    "link": "/kurse/mathe-2/vorlesungen/analysis-2/1"
                  },
                  {
                    "text": "5.2 Eigenschaften differenzierbarer Funktionen",
                    "link": "/kurse/mathe-2/vorlesungen/analysis-2/2"
                  },
                  {
                    "text": "5.3 Extremwerte",
                    "link": "/kurse/mathe-2/vorlesungen/analysis-2/3"
                  },
                  {
                    "text": "5.4 Integration in ℝ",
                    "link": "/kurse/mathe-2/vorlesungen/analysis-2/4"
                  },
                  {
                    "text": "5.5 Integrationstechniken",
                    "link": "/kurse/mathe-2/vorlesungen/analysis-2/5"
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "text": "Algo",
        "collapsed": true,
        "items": [
          {
            "text": "Übersicht",
            "link": "/kurse/algo/"
          },
          {
            "text": "Inhalte",
            "items": [
              {
                "text": "",
                "collapsed": true,
                "items": [
                  {
                    "text": "",
                    "link": "/kurse/algo/vorlesungen/"
                  }
                ]
              }
            ]
          },
          {
            "text": "Klausur",
            "link": "/kurse/algo/klausur.md"
          }
        ]
      }
    ],
    "/": [
      {
        "text": "Startseite",
        "link": "/"
      },
      {
        "text": "Kurse",
        "link": "/kurse/mathe-2/"
      }
    ]
  },
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/vuejs/vitepress"
    }
  ],
  "search": {
    "provider": "local"
  }
}

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.