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

{
  "search": {
    "provider": "local"
  },
  "nav": [
    {
      "text": "Home",
      "link": "/"
    },
    {
      "text": "Database",
      "link": "/databases"
    },
    {
      "text": "Web",
      "link": "/web"
    },
    {
      "text": "Algorithm",
      "link": "/algorithm"
    },
    {
      "text": "Interview",
      "link": "/interview"
    },
    {
      "text": "GCP ACE",
      "link": "/gcp-ace/index.md"
    },
    {
      "text": "Golang",
      "link": "/golang/index.md"
    }
  ],
  "sidebar": {
    "/algorithm/": [
      {
        "text": "ALGORITHM",
        "items": [
          {
            "text": "CRDT (Conflict-free Replicated Data Types)",
            "link": "/algorithm/crdt-conflict-free-replicated-data-types"
          },
          {
            "text": "DSA Interview",
            "link": "/algorithm/dsa-interview"
          },
          {
            "text": "Popular Algorithms for System Design Interviews",
            "link": "/algorithm/popular-algorithms-for-system-design-interviews"
          },
          {
            "text": "Two Pointer",
            "link": "/algorithm/two-pointer"
          }
        ]
      }
    ],
    "/databases/": [
      {
        "text": "DATABASES",
        "items": [
          {
            "text": "Chroma",
            "link": "/databases/chroma"
          },
          {
            "text": "Cơ chế locking và xử lý tranh chấp trong MySQL",
            "link": "/databases/cơ-chế-locking-và-xử-lý-tranh-chấp-trong-mysql"
          },
          {
            "text": "Database Overview",
            "link": "/databases/database-overview"
          },
          {
            "text": "Elasticsearch",
            "link": "/databases/elasticsearch"
          },
          {
            "text": "PostgreSQL",
            "link": "/databases/postgresql"
          },
          {
            "text": "PostgresSQL Query in Practice",
            "link": "/databases/postgressql-query-in-practice"
          }
        ]
      }
    ],
    "/gcp-ace/": [
      {
        "text": "GCP-ACE",
        "items": [
          {
            "text": "Giới thiệu về VPC",
            "link": "/gcp-ace/01-vpc"
          },
          {
            "text": "Tổng hợp cú pháp Markdown đầy đủ",
            "link": "/gcp-ace/02-test1"
          },
          {
            "text": "Azure Fundamental",
            "link": "/gcp-ace/azure-fundamental"
          },
          {
            "text": "BigQuery",
            "link": "/gcp-ace/bigquery"
          },
          {
            "text": "Deployment Manager",
            "link": "/gcp-ace/deployment-manager"
          },
          {
            "text": "Google Kubernetes Engine (GKE)",
            "link": "/gcp-ace/google-kubernetes-engine-gke"
          },
          {
            "text": "IAM",
            "link": "/gcp-ace/iam"
          },
          {
            "text": "Instance Group",
            "link": "/gcp-ace/instance-group"
          },
          {
            "text": "Serverless",
            "link": "/gcp-ace/serverless"
          }
        ]
      }
    ],
    "/golang/": [
      {
        "text": "GOLANG",
        "items": [
          {
            "text": "Echo Framework",
            "link": "/golang/echo-framework"
          },
          {
            "text": "Speaking Test Tips",
            "link": "/golang/speaking-test-tips"
          },
          {
            "text": "Speaking Test",
            "link": "/golang/speaking-test"
          },
          {
            "text": "Truy vấn database trong Golang",
            "link": "/golang/truy-vấn-database-trong-golang"
          }
        ]
      }
    ],
    "/interview/": [
      {
        "text": "INTERVIEW",
        "items": [
          {
            "text": "Cloud Overview",
            "link": "/interview/cloud-overview"
          },
          {
            "text": "Top 10 Design Pattern",
            "link": "/interview/design-pattern"
          },
          {
            "text": "FPT 2",
            "link": "/interview/fpt-2"
          },
          {
            "text": "Reviewing Knowledge After the FPT Interview",
            "link": "/interview/fpt-after-interview"
          },
          {
            "text": "FPT Software Behavior English",
            "link": "/interview/fpt-behavior"
          },
          {
            "text": "Interview 2",
            "link": "/interview/interview-2"
          },
          {
            "text": "Interview 3",
            "link": "/interview/interview-3"
          },
          {
            "text": "Interview 4",
            "link": "/interview/interview-4"
          },
          {
            "text": "Ôn tập Interview Advanced",
            "link": "/interview/on-interview-advanced"
          },
          {
            "text": "OOP Advanced",
            "link": "/interview/oop-advanced"
          },
          {
            "text": "Redis Short",
            "link": "/interview/redis-short"
          },
          {
            "text": "Ôn tập Interview",
            "link": "/interview/ôn-tập-interview"
          }
        ]
      }
    ],
    "/web/": [
      {
        "text": "WEB",
        "items": [
          {
            "text": "FPT Softwawre Interview",
            "link": "/web/fpt-software-interview"
          },
          {
            "text": "Gin Framework Golang",
            "link": "/web/gin-framework"
          },
          {
            "text": "Golang Backend",
            "link": "/web/golang-backend"
          },
          {
            "text": "Java Advanced",
            "link": "/web/java-advanced"
          },
          {
            "text": "Java Beginner",
            "link": "/web/java-beginner"
          },
          {
            "text": "Kafka 2",
            "link": "/web/kafka-1"
          },
          {
            "text": "Kafka",
            "link": "/web/kafka"
          },
          {
            "text": "LangChain ",
            "link": "/web/langchain"
          },
          {
            "text": "Microservices",
            "link": "/web/microservices"
          },
          {
            "text": "NodeJs 2",
            "link": "/web/nodejs-1"
          },
          {
            "text": "NodeJs",
            "link": "/web/nodejs"
          },
          {
            "text": "Notification System",
            "link": "/web/notification-system"
          },
          {
            "text": "React",
            "link": "/web/react"
          },
          {
            "text": "Redis Advanced",
            "link": "/web/redis-advanced"
          },
          {
            "text": "Redis Nâng cao",
            "link": "/web/redis-nâng-cao"
          },
          {
            "text": "Redis",
            "link": "/web/redis"
          },
          {
            "text": "Spring Framework toàn tập",
            "link": "/web/spring-framework-toàn-tập"
          },
          {
            "text": "WebRTC",
            "link": "/web/webrtc"
          },
          {
            "text": "WebSocket",
            "link": "/web/websocket"
          }
        ]
      }
    ]
  },
  "socialLinks": [
    {
      "icon": "github",
      "link": "https://github.com/vuejs/vitepress"
    }
  ]
}

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.