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": "DSA",
      "link": "/dsa/index"
    },
    {
      "text": "ML & DL",
      "items": [
        {
          "text": "Machine Learning",
          "link": "/machine-deep/ml/index"
        },
        {
          "text": "Deep Learning",
          "link": "/machine-deep/dl/index"
        },
        {
          "text": "INFSCI0310",
          "link": "/machine-deep/infsci0310/index"
        }
      ]
    },
    {
      "text": "Examples",
      "link": "/markdown-examples"
    }
  ],
  "sidebar": {
    "/dsa": [
      {
        "items": [
          {
            "text": "Getting Started",
            "link": "/dsa/index"
          },
          {
            "text": "Exercises",
            "link": "/dsa/exercise"
          },
          {
            "text": "01-Introduction",
            "link": "/dsa/introduction"
          },
          {
            "text": "02-Array and Vector",
            "link": "/dsa/array-and-vector"
          },
          {
            "text": "03-List",
            "link": "/dsa/list-and-node"
          },
          {
            "text": "04-Stack and Queue",
            "link": "/dsa/stack-and-queue"
          },
          {
            "text": "05-Sorting",
            "link": "/dsa/sorting"
          },
          {
            "text": "06-Tree",
            "link": "/dsa/tree"
          },
          {
            "text": "07-Advanced Search Tree",
            "link": "/dsa/advanced-search-tree"
          },
          {
            "text": "08-Tree Like DS",
            "link": "/dsa/tree-like-structures"
          },
          {
            "text": "09-Hash",
            "link": "/dsa/hash-and-collusion"
          },
          {
            "text": "10-Heap",
            "link": "/dsa/heap-and-huffman-tree"
          },
          {
            "text": "11-String",
            "link": "/dsa/string"
          },
          {
            "text": "12-Graph",
            "link": "/dsa/graph"
          },
          {
            "text": "13-Search",
            "link": "/dsa/search"
          },
          {
            "text": "14-Divide and Conquer",
            "link": "/dsa/divide-and-conquer"
          }
        ]
      }
    ],
    "/machine-deep/ml": [
      {
        "items": [
          {
            "text": "01-绪论",
            "link": "/machine-deep/ml/index"
          },
          {
            "text": "02-模型评估与选择",
            "link": "/machine-deep/ml/model-evaluation-selection"
          },
          {
            "text": "03-线性模型",
            "link": "/machine-deep/ml/linear-model"
          },
          {
            "text": "04-决策树",
            "link": "/machine-deep/ml/decision-tree"
          },
          {
            "text": "05-神经网络",
            "link": "/machine-deep/ml/neural-network"
          },
          {
            "text": "06-支持向量机",
            "link": "/machine-deep/ml/svm"
          },
          {
            "text": "07-贝叶斯分类器",
            "link": "/machine-deep/ml/bayesian-classifier"
          },
          {
            "text": "08-集成学习",
            "link": "/machine-deep/ml/ensemble-learning"
          },
          {
            "text": "09-聚类",
            "link": "/machine-deep/ml/clustering"
          },
          {
            "text": "10-降维与度量值学习",
            "link": "/machine-deep/ml/dimensionality-reduction"
          },
          {
            "text": "11-特征选择与稀疏学习",
            "link": "/machine-deep/ml/feature-selection"
          },
          {
            "text": "12-计算学习理论",
            "link": "/machine-deep/ml/computational-learning-theory"
          },
          {
            "text": "13-半监督学习",
            "link": "/machine-deep/ml/semi-supervised-learning"
          },
          {
            "text": "14-概率图模型",
            "link": "/machine-deep/ml/probabilistic-graphical-model"
          },
          {
            "text": "15-强化学习",
            "link": "/machine-deep/ml/reinforcement-learning"
          },
          {
            "text": "数据分析 - 监督学习",
            "link": "/machine-deep/ml/supervised-learning"
          },
          {
            "text": "数据分析 - 无监督学习",
            "link": "/machine-deep/ml/unsupervised-learning"
          }
        ]
      }
    ],
    "/machine-deep/dl": [
      {
        "items": [
          {
            "text": "01-Overview",
            "link": "/machine-deep/dl/index"
          },
          {
            "text": "RNN",
            "link": "/machine-deep/dl/recurrent-neural-network"
          }
        ]
      }
    ],
    "/machine-deep/infsci0310": [
      {
        "items": [
          {
            "text": "01-Intro to Information Science",
            "link": "/machine-deep/infsci0310/index"
          },
          {
            "text": "02-Information Representation",
            "link": "/machine-deep/infsci0310/info-representation"
          },
          {
            "text": "03-Gradient Descent",
            "link": "/machine-deep/infsci0310/gradient-descent"
          },
          {
            "text": "04-Optimization",
            "link": "/machine-deep/infsci0310/optimization"
          },
          {
            "text": "05-Statistics Inference",
            "link": "/machine-deep/infsci0310/statistics-inference"
          },
          {
            "text": "06-Stochastic, Simulation and Sampling",
            "link": "/machine-deep/infsci0310/stochastic-simulation-sampling"
          },
          {
            "text": "07-Linear Regression",
            "link": "/machine-deep/infsci0310/linear-regression"
          },
          {
            "text": "08-Python Basics",
            "link": "/machine-deep/infsci0310/python-basics"
          },
          {
            "text": "09-P-and-NP",
            "link": "/machine-deep/infsci0310/p-and-np"
          }
        ]
      }
    ]
  },
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/acceleratez/docs"
    }
  ],
  "search": {
    "provider": "local",
    "options": {
      "translations": {
        "button": {
          "buttonText": "搜索文档",
          "buttonAriaLabel": "搜索文档"
        },
        "modal": {
          "noResultsText": "无法找到相关结果",
          "resetButtonTitle": "清除查询条件",
          "footer": {
            "selectText": "选择",
            "navigateText": "切换"
          }
        }
      }
    }
  },
  "outlineTitle": "Content",
  "outline": [
    1,
    3
  ]
}

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.