Skip to content

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:

md
<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": "Inicio",
      "link": "/"
    },
    {
      "text": "Productos",
      "items": [
        {
          "text": "Smart Medic",
          "link": "/smart-medic/"
        },
        {
          "text": "Smart Medic: descargar PDF",
          "link": "/manual-smart-medic.pdf",
          "target": "_blank"
        }
      ]
    }
  ],
  "sidebar": {
    "/smart-medic/": [
      {
        "text": "Smart Medic",
        "items": [
          {
            "text": "Introducción",
            "link": "/smart-medic/"
          }
        ]
      },
      {
        "text": "Primeros pasos",
        "items": [
          {
            "text": "Resumen",
            "link": "/smart-medic/primeros-pasos/"
          },
          {
            "text": "Instalación",
            "link": "/smart-medic/instalacion/"
          },
          {
            "text": "Ingresar y salir",
            "link": "/smart-medic/primeros-pasos/ingreso/"
          },
          {
            "text": "Pantalla principal y menú",
            "link": "/smart-medic/primeros-pasos/navegacion/"
          },
          {
            "text": "Cómo usar las listas",
            "link": "/smart-medic/primeros-pasos/listas/"
          }
        ]
      },
      {
        "text": "Módulos",
        "items": [
          {
            "text": "Administración",
            "collapsed": true,
            "items": [
              {
                "text": "Resumen",
                "link": "/smart-medic/modulos/administracion/"
              },
              {
                "text": "Catálogos de personal",
                "link": "/smart-medic/modulos/administracion/catalogos-personal/"
              },
              {
                "text": "Catálogos de productos",
                "link": "/smart-medic/modulos/administracion/catalogos-productos/"
              },
              {
                "text": "Catálogos generales",
                "link": "/smart-medic/modulos/administracion/catalogos-generales/"
              },
              {
                "text": "Configuración de la empresa",
                "link": "/smart-medic/modulos/administracion/configuracion/"
              },
              {
                "text": "Horarios",
                "link": "/smart-medic/modulos/administracion/horarios/"
              },
              {
                "text": "Trabajadores y permisos",
                "link": "/smart-medic/modulos/administracion/trabajadores/"
              }
            ]
          },
          {
            "text": "Admisión",
            "collapsed": true,
            "items": [
              {
                "text": "Resumen",
                "link": "/smart-medic/modulos/admision/"
              },
              {
                "text": "Medios de interacción",
                "link": "/smart-medic/modulos/admision/medios-interaccion/"
              },
              {
                "text": "Pacientes",
                "link": "/smart-medic/modulos/admision/pacientes/"
              },
              {
                "text": "Tipo de identificación",
                "link": "/smart-medic/modulos/admision/tipo-identificacion/"
              }
            ]
          },
          {
            "text": "Almacén",
            "collapsed": true,
            "items": [
              {
                "text": "Resumen",
                "link": "/smart-medic/modulos/almacen/"
              },
              {
                "text": "Almacenes",
                "link": "/smart-medic/modulos/almacen/almacenes/"
              },
              {
                "text": "Guías",
                "link": "/smart-medic/modulos/almacen/guias/"
              },
              {
                "text": "Lotes",
                "link": "/smart-medic/modulos/almacen/lotes/"
              },
              {
                "text": "Movimiento de Stock",
                "link": "/smart-medic/modulos/almacen/movimiento-stock/"
              },
              {
                "text": "Stock",
                "link": "/smart-medic/modulos/almacen/stock/"
              }
            ]
          },
          {
            "text": "Caja",
            "collapsed": true,
            "items": [
              {
                "text": "Resumen",
                "link": "/smart-medic/modulos/caja/"
              },
              {
                "text": "Movimientos de caja",
                "link": "/smart-medic/modulos/caja/movimientos/"
              },
              {
                "text": "Reportes",
                "link": "/smart-medic/modulos/caja/reportes/"
              }
            ]
          },
          {
            "text": "Citas",
            "collapsed": true,
            "items": [
              {
                "text": "Resumen",
                "link": "/smart-medic/modulos/citas/"
              },
              {
                "text": "Atenciones",
                "link": "/smart-medic/modulos/citas/atenciones/"
              },
              {
                "text": "Recordatorio de Citas",
                "link": "/smart-medic/modulos/citas/recordatorio/"
              },
              {
                "text": "Reservar cita",
                "link": "/smart-medic/modulos/citas/reservar-cita/"
              }
            ]
          },
          {
            "text": "Citas Whatsapp",
            "collapsed": true,
            "items": [
              {
                "text": "Resumen",
                "link": "/smart-medic/modulos/citas-whatsapp/"
              },
              {
                "text": "Reservas",
                "link": "/smart-medic/modulos/citas-whatsapp/reservas/"
              }
            ]
          },
          {
            "text": "Control de Gastos",
            "collapsed": true,
            "items": [
              {
                "text": "Resumen",
                "link": "/smart-medic/modulos/control-gastos/"
              },
              {
                "text": "Catálogos de gastos",
                "link": "/smart-medic/modulos/control-gastos/catalogos/"
              },
              {
                "text": "Cuentas por pagar",
                "link": "/smart-medic/modulos/control-gastos/cuentas/"
              }
            ]
          },
          {
            "text": "Cuenta Corriente",
            "collapsed": true,
            "items": [
              {
                "text": "Resumen",
                "link": "/smart-medic/modulos/cuenta-corriente/"
              },
              {
                "text": "Por Paciente",
                "link": "/smart-medic/modulos/cuenta-corriente/por-paciente/"
              }
            ]
          },
          {
            "text": "Farmacia",
            "collapsed": true,
            "items": [
              {
                "text": "Resumen",
                "link": "/smart-medic/modulos/farmacia/"
              },
              {
                "text": "Catálogos",
                "link": "/smart-medic/modulos/farmacia/catalogos/"
              },
              {
                "text": "POS",
                "link": "/smart-medic/modulos/farmacia/pos/"
              },
              {
                "text": "Productos",
                "link": "/smart-medic/modulos/farmacia/productos/"
              }
            ]
          },
          {
            "text": "Historia clínica",
            "collapsed": true,
            "items": [
              {
                "text": "Resumen",
                "link": "/smart-medic/modulos/historia-clinica/"
              },
              {
                "text": "Cirugías",
                "link": "/smart-medic/modulos/historia-clinica/cirugias/"
              },
              {
                "text": "Descanso médico",
                "link": "/smart-medic/modulos/historia-clinica/descanso-medico/"
              },
              {
                "text": "Recetas",
                "link": "/smart-medic/modulos/historia-clinica/recetas/"
              },
              {
                "text": "Registrar una consulta",
                "link": "/smart-medic/modulos/historia-clinica/consulta/"
              }
            ]
          },
          {
            "text": "Hospitalización",
            "collapsed": true,
            "items": [
              {
                "text": "Resumen",
                "link": "/smart-medic/modulos/hospitalizacion/"
              },
              {
                "text": "Cobranzas",
                "link": "/smart-medic/modulos/hospitalizacion/cobranzas/"
              },
              {
                "text": "Configuración",
                "link": "/smart-medic/modulos/hospitalizacion/configuracion/"
              },
              {
                "text": "Episodios",
                "link": "/smart-medic/modulos/hospitalizacion/episodios/"
              },
              {
                "text": "Panel de camas",
                "link": "/smart-medic/modulos/hospitalizacion/panel-camas/"
              }
            ]
          },
          {
            "text": "Imágenes",
            "collapsed": true,
            "items": [
              {
                "text": "Resumen",
                "link": "/smart-medic/modulos/imagenes/"
              },
              {
                "text": "Equipos",
                "link": "/smart-medic/modulos/imagenes/equipos/"
              },
              {
                "text": "Estudios",
                "link": "/smart-medic/modulos/imagenes/estudios/"
              },
              {
                "text": "Órdenes",
                "link": "/smart-medic/modulos/imagenes/ordenes/"
              },
              {
                "text": "Salas",
                "link": "/smart-medic/modulos/imagenes/salas/"
              }
            ]
          },
          {
            "text": "Laboratorio",
            "collapsed": true,
            "items": [
              {
                "text": "Resumen",
                "link": "/smart-medic/modulos/laboratorio/"
              },
              {
                "text": "Análisis",
                "link": "/smart-medic/modulos/laboratorio/analisis/"
              },
              {
                "text": "Órdenes",
                "link": "/smart-medic/modulos/laboratorio/ordenes/"
              },
              {
                "text": "Tipo de examen",
                "link": "/smart-medic/modulos/laboratorio/tipo-examen/"
              },
              {
                "text": "Tipo de muestra",
                "link": "/smart-medic/modulos/laboratorio/tipo-muestra/"
              },
              {
                "text": "Verificar resultado",
                "link": "/smart-medic/modulos/laboratorio/verificar-resultado/"
              }
            ]
          },
          {
            "text": "Reportes",
            "collapsed": true,
            "items": [
              {
                "text": "Resumen",
                "link": "/smart-medic/modulos/reportes/"
              },
              {
                "text": "Citas",
                "link": "/smart-medic/modulos/reportes/citas/"
              },
              {
                "text": "Liquidación",
                "link": "/smart-medic/modulos/reportes/liquidacion/"
              },
              {
                "text": "Stock y Tramas",
                "link": "/smart-medic/modulos/reportes/stock-tramas/"
              },
              {
                "text": "Ventas",
                "link": "/smart-medic/modulos/reportes/ventas/"
              }
            ]
          },
          {
            "text": "Ventas",
            "collapsed": true,
            "items": [
              {
                "text": "Resumen",
                "link": "/smart-medic/modulos/ventas/"
              },
              {
                "text": "Cuenta corriente",
                "link": "/smart-medic/modulos/ventas/cuenta-corriente/"
              },
              {
                "text": "Notas de crédito",
                "link": "/smart-medic/modulos/ventas/notas-credito/"
              },
              {
                "text": "Nueva venta",
                "link": "/smart-medic/modulos/ventas/nueva-venta/"
              },
              {
                "text": "Registros",
                "link": "/smart-medic/modulos/ventas/registros/"
              },
              {
                "text": "Resumen Diario",
                "link": "/smart-medic/modulos/ventas/resumen-diario/"
              }
            ]
          }
        ]
      },
      {
        "text": "Ayuda",
        "items": [
          {
            "text": "Preguntas frecuentes",
            "link": "/smart-medic/preguntas-frecuentes/"
          },
          {
            "text": "Glosario",
            "link": "/smart-medic/glosario/"
          },
          {
            "text": "Videos",
            "link": "/smart-medic/videos/"
          }
        ]
      }
    ]
  },
  "search": {
    "provider": "local"
  },
  "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.