Runtime API Examples

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

{
  "logo": "/assets/favicon.ico",
  "nav": [
    {
      "text": "Home",
      "link": "/"
    },
    {
      "text": "Try demo",
      "link": "https://inkble.com"
    },
    {
      "text": "Contact US",
      "items": [
        {
          "text": "Telegram",
          "link": "https://t.me/Jolie_Inkble"
        },
        {
          "text": "Facebook",
          "link": "https://www.facebook.com/messages/t/323244550880043"
        }
      ]
    }
  ],
  "sidebar": [
    {
      "text": "Mục lục",
      "link": "/table_of_content"
    },
    {
      "text": "Đăng kí dịch vụ",
      "items": [
        {
          "text": "Đăng kí",
          "link": "/user/signup"
        },
        {
          "text": "Tạo tổ chức",
          "link": "/user/organizations"
        },
        {
          "text": "Thêm thành viên",
          "link": "/user/add_new_member"
        },
        {
          "text": "Phân quyền",
          "link": "/user/user_role"
        }
      ]
    },
    {
      "text": "Thống kê",
      "items": [
        {
          "text": "Biểu đồ",
          "link": "/analytics/data_chart"
        },
        {
          "text": "Thống kê đơn hàng",
          "link": "/dashboard"
        },
        {
          "text": "Doanh số cá nhân",
          "link": "/dashboard/user_dashboard"
        },
        {
          "text": "Tải dữ liệu doanh thu",
          "link": "/dashboard/download_data"
        }
      ]
    },
    {
      "text": "Sản phẩm",
      "items": [
        {
          "text": "Tạo sản phẩm",
          "link": "/product/create"
        },
        {
          "text": "Danh sách sản phẩm",
          "link": "/product/list_product"
        },
        {
          "text": "Bản mẫu",
          "link": "/product/template"
        },
        {
          "text": "Dữ liệu sản phẩm",
          "link": "/product/feed"
        }
      ]
    },
    {
      "text": "Danh mục sản phẩm",
      "items": [
        {
          "text": "Danh sách",
          "link": "/product/sort"
        }
      ]
    },
    {
      "text": "Đơn hàng",
      "items": [
        {
          "text": "Danh sách đơn hàng",
          "link": "/order"
        },
        {
          "text": "Tạo đơn hàng thủ công",
          "link": "/order/create_new_order"
        },
        {
          "text": "Cập nhật thông tin đơn hàng",
          "link": "/order/edit_order"
        },
        {
          "text": "Yêu cầu sản xuất",
          "link": "/order/fulfill"
        },
        {
          "text": "Theo dõi đơn hàng",
          "link": "/order/tracking"
        },
        {
          "text": "Cập nhật đơn hàng lỗi",
          "link": "/order/error_order"
        },
        {
          "text": "Nhập đơn hàng từ file excel",
          "link": "/order/import_order"
        },
        {
          "text": "Huỷ đơn hàng",
          "link": "/order/cancel_order"
        }
      ]
    },
    {
      "text": "Thiết kế",
      "items": [
        {
          "text": "Đăng tải thiết kế",
          "link": "/design/upload_design"
        },
        {
          "text": "Thống kê",
          "link": "/design/dashboard"
        },
        {
          "text": "Danh sách",
          "link": "/design/list"
        },
        {
          "text": "Hỗ trợ Excel",
          "link": "/design/import_excel"
        }
      ]
    },
    {
      "text": "Ứng dụng",
      "items": [
        {
          "text": "Facebook",
          "items": [
            {
              "text": "Tài khoản",
              "link": "/facebook/get_token"
            },
            {
              "text": "Tạo camp",
              "link": "/facebook/create_camp"
            },
            {
              "text": "Danh sách camp",
              "link": "/facebook/list_camp"
            }
          ]
        }
      ]
    },
    {
      "text": "Cài đặt",
      "items": [
        {
          "text": "Tổng quan",
          "items": [
            {
              "text": "S3",
              "link": "/setting/S3"
            },
            {
              "text": "Google Storage",
              "link": "/setting/google_storage"
            },
            {
              "text": "Tổ chức",
              "link": "/setting/general"
            },
            {
              "text": "Múi giờ",
              "link": "/setting/timezone"
            }
          ]
        },
        {
          "text": "SKU",
          "link": "/setting/sku"
        },
        {
          "text": "Cửa hàng",
          "items": [
            {
              "text": "Shopify",
              "link": "/store/shopify"
            },
            {
              "text": "Shopbase",
              "link": "/store/shopbase"
            }
          ]
        },
        {
          "text": "Thanh toán",
          "link": "/setting/billing"
        }
      ]
    },
    {
      "text": "Tài liệu tham khảo API",
      "items": [
        {
          "text": "Access token",
          "link": "/api_reference/access_token"
        },
        {
          "text": "Kiểm tra thông tin",
          "link": "/api_reference/info"
        },
        {
          "text": "Tạo đơn hàng",
          "link": "/api_reference/order"
        }
      ]
    }
  ],
  "socialLinks": []
}

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.