docs: add descriptions [lunaria-ignore]

pull/5158/head
Divyansh Singh 4 weeks ago
parent d96bf1dc61
commit 8ad215400a

@ -1,3 +1,7 @@
---
description: Learn how to reference and handle static assets such as images, media, and fonts in VitePress.
---
# Asset Handling
## Referencing Static Assets

@ -1,5 +1,6 @@
---
outline: deep
description: Connect VitePress to a headless CMS using dynamic routes and data loaders.
---
# Connecting to a CMS

@ -1,3 +1,7 @@
---
description: Create and use a custom theme in VitePress to fully control the look and feel of your site.
---
# Using a Custom Theme
## Theme Resolving

@ -1,3 +1,7 @@
---
description: Load arbitrary data at build time using VitePress data loaders and import it from pages or components.
---
# Build-Time Data Loading
VitePress provides a feature called **data loaders** that allows you to load arbitrary data and import it from pages or components. The data loading is executed **only at build time**: the resulting data will be serialized as JSON in the final JavaScript bundle.

@ -1,5 +1,6 @@
---
outline: deep
description: Deploy your VitePress site to popular platforms like Netlify, Vercel, GitHub Pages, and more.
---
# Deploy Your VitePress Site

@ -1,5 +1,6 @@
---
outline: deep
description: Customize and extend the VitePress default theme with custom CSS, components, layouts, and slots.
---
# Extending the Default Theme

@ -1,3 +1,7 @@
---
description: Learn how to use YAML frontmatter in VitePress Markdown files to control page-level metadata and behavior.
---
# Frontmatter
## Usage

@ -1,3 +1,7 @@
---
description: Get up and running with VitePress. Learn how to install, scaffold, and start developing your documentation site.
---
# Getting Started
## Try It Online

@ -1,3 +1,7 @@
---
description: Set up internationalization (i18n) in VitePress to support multiple languages for your site.
---
# Internationalization
To use the built-in i18n features, one needs to create a directory structure as follows:

@ -1,3 +1,7 @@
---
description: VitePress built-in Markdown extensions including custom containers, code blocks with syntax highlighting, line highlighting, code groups, and more.
---
# Markdown Extensions
VitePress comes with built in Markdown Extensions.

@ -1,3 +1,7 @@
---
description: Enable MPA (Multi-Page Application) mode in VitePress for zero-JavaScript pages with better initial performance.
---
# MPA Mode <Badge type="warning" text="experimental" />
MPA (Multi-Page Application) mode can be enabled via the command line via `vitepress build --mpa`, or via config through the `mpa: true` option.

@ -1,5 +1,6 @@
---
outline: deep
description: Understand VitePress file-based routing, dynamic routes, clean URLs, and path rewrites.
---
# Routing

@ -1,3 +1,7 @@
---
description: Generate a sitemap.xml file for your VitePress site to improve search engine discoverability.
---
# Sitemap Generation
VitePress comes with out-of-the-box support for generating a `sitemap.xml` file for your site. To enable it, add the following to your `.vitepress/config.js`:

@ -1,5 +1,6 @@
---
outline: deep
description: Ensure your VitePress theme components and custom code are compatible with server-side rendering.
---
# SSR Compatibility

@ -1,3 +1,7 @@
---
description: Use Vue components and dynamic templating features directly inside Markdown files in VitePress.
---
# Using Vue in Markdown
In VitePress, each Markdown file is compiled into HTML and then processed as a [Vue Single-File Component](https://vuejs.org/guide/scaling-up/sfc.html). This means you can use any Vue features inside the Markdown, including dynamic templating, using Vue components, or arbitrary in-page Vue component logic by adding a `<script>` tag.

@ -1,3 +1,7 @@
---
description: VitePress is a static site generator designed for building fast, content-centric websites powered by Vite and Vue.
---
# What is VitePress?
VitePress is a [Static Site Generator](https://en.wikipedia.org/wiki/Static_site_generator) (SSG) designed for building fast, content-centric websites. In a nutshell, VitePress takes your source content written in [Markdown](https://en.wikipedia.org/wiki/Markdown), applies a theme to it, and generates static HTML pages that can be easily deployed anywhere.

@ -1,4 +1,5 @@
---
description: VitePress is a Vite & Vue powered static site generator that lets you create beautiful documentation sites from Markdown.
layout: home
hero:

@ -1,3 +1,7 @@
---
description: Reference of VitePress CLI commands including dev, build, preview, and init.
---
# Command Line Interface
## `vitepress dev`

@ -1,3 +1,7 @@
---
description: Use the Badge component to add status labels to headers in VitePress documentation.
---
# Badge
The badge lets you add status to your headers. For example, it could be useful to specify the section's type, or supported version.

@ -1,3 +1,7 @@
---
description: Integrate Carbon Ads into your VitePress site using the default theme's built-in support.
---
# Carbon Ads
VitePress has built in native support for [Carbon Ads](https://www.carbonads.net/). By defining the Carbon Ads credentials in config, VitePress will display ads on the page.

@ -1,3 +1,7 @@
---
description: Reference of all configuration options available for the VitePress default theme.
---
# Default Theme Config
Theme config lets you customize your theme. You can define theme config via the `themeConfig` option in the config file:

@ -1,3 +1,7 @@
---
description: Display an edit link on doc pages to let users suggest changes on GitHub or GitLab.
---
# Edit Link
## Site-Level Config

@ -1,3 +1,7 @@
---
description: Configure the global footer displayed at the bottom of VitePress pages.
---
# Footer
VitePress will display global footer at the bottom of the page when `themeConfig.footer` is present.

@ -1,3 +1,7 @@
---
description: Configure the VitePress default theme home page layout with hero sections, features, and custom content.
---
# Home Page
VitePress default theme provides a homepage layout, which you can also see used on [the homepage of this site](../). You may use it on any of your pages by specifying `layout: home` in the [frontmatter](./frontmatter-config).

@ -1,3 +1,7 @@
---
description: Show the last updated timestamp on VitePress pages based on Git commit history.
---
# Last Updated
The update time of the last content will be displayed in the lower right corner of the page. To enable it, add `lastUpdated` options to your config.

@ -1,3 +1,7 @@
---
description: Choose between doc, page, and home layouts in the VitePress default theme.
---
# Layout
You may choose the page layout by setting `layout` option to the page [frontmatter](./frontmatter-config). There are 3 layout options, `doc`, `page`, and `home`. If nothing is specified, then the page is treated as `doc` page.

@ -1,3 +1,7 @@
---
description: Configure the navigation bar in the VitePress default theme including site title, logo, and menu links.
---
# Nav
The Nav is the navigation bar displayed on top of the page. It contains the site title, global menu links, etc.

@ -1,3 +1,7 @@
---
description: Customize the previous and next page links displayed at the bottom of doc pages in VitePress.
---
# Prev Next Links
You can customize the text and link for the previous and next pages (shown at doc footer). This is helpful if you want a different text there than what you have on your sidebar. Additionally, you may find it useful to disable the footer or link to a page that is not included in your sidebar.

@ -1,5 +1,6 @@
---
outline: deep
description: Set up local or Algolia-powered search for your VitePress site.
---
# Search

@ -1,3 +1,7 @@
---
description: Configure the sidebar navigation in the VitePress default theme with groups, collapsible sections, and multiple sidebars.
---
# Sidebar
The sidebar is the main navigation block for your documentation. You can configure the sidebar menu in [`themeConfig.sidebar`](./default-theme-config#sidebar).

@ -1,3 +1,7 @@
---
description: Create team pages with member profiles using VitePress built-in team components.
---
<script setup>
import { VPTeamMembers } from 'vitepress/theme'

@ -1,5 +1,6 @@
---
outline: deep
description: Reference of all available frontmatter configuration options for VitePress Markdown pages.
---
# Frontmatter Config

@ -1,3 +1,7 @@
---
description: Reference of VitePress runtime APIs including composables, helper functions, and built-in components.
---
# Runtime API
VitePress offers several built-in APIs to let you access app data. VitePress also comes with a few built-in components that can be used globally.

@ -1,5 +1,6 @@
---
outline: deep
description: Complete reference of VitePress site configuration options including app-level settings, theming, and build options.
---
# Site Config

@ -1,3 +1,7 @@
---
description: Aprende cómo referenciar y manejar recursos estáticos como imágenes, medios y fuentes en VitePress.
---
# Manejo de Assets {#asset-handling}
## Referenciando Assets Estáticos {#referencing-static-assets}

@ -1,4 +1,5 @@
---
description: Conecta VitePress a un CMS headless usando rutas dinámicas y cargadores de datos.
outline: deep
---

@ -1,3 +1,7 @@
---
description: Crea y usa un tema personalizado en VitePress para controlar completamente la apariencia y el estilo de tu sitio.
---
# Usando un Tema Personalizado {#using-a-custom-theme}
## Carga de Tema {#theme-resolving}

@ -1,3 +1,7 @@
---
description: Carga datos arbitrarios en tiempo de compilación usando cargadores de datos de VitePress e impórtalos desde páginas o componentes.
---
# Carga de Datos en Tiempo de Compilacion {#build-time-data-loading}
VitePress proporciona un recurso llamado **cargadores de dato** que permite cargar datos arbitrarios e importarlos desde páginas o componentes. La carga de datos es ejecutada **apenas en el tiempo del build** los datos resultantes serán serializados como JSON en el paquete de JavaScript final.

@ -1,4 +1,5 @@
---
description: Despliega tu sitio VitePress en plataformas populares como Netlify, Vercel, GitHub Pages y más.
outline: deep
---

@ -1,4 +1,5 @@
---
description: Personaliza y extiende el tema predeterminado de VitePress con CSS personalizado, componentes, layouts y slots.
outline: deep
---

@ -1,3 +1,7 @@
---
description: Aprende cómo usar frontmatter YAML en archivos Markdown de VitePress para controlar los metadatos y el comportamiento a nivel de página.
---
# Frontmatter
## Uso {#usage}

@ -1,3 +1,7 @@
---
description: Comienza a trabajar con VitePress. Aprende cómo instalar, crear la estructura y comenzar a desarrollar tu sitio de documentación.
---
# Iniciando {#getting-started}
## Experimente Online {#try-it-online}

@ -1,3 +1,7 @@
---
description: Configura la internacionalización (i18n) en VitePress para soportar múltiples idiomas en tu sitio.
---
# Internacionalización {#internationalization}
Para usar recursos de i18n integrados, es necesario crear una estructura de directorios de la siguiente forma:

@ -1,3 +1,7 @@
---
description: Extensiones Markdown integradas en VitePress, incluyendo contenedores personalizados, bloques de código con resaltado de sintaxis, resaltado de líneas, grupos de código y más.
---
# Extensiones Markdown {#markdown-extensions}
VitePress viene con Extensiones embutidas.

@ -1,3 +1,7 @@
---
description: Habilita el modo MPA (Aplicación de Múltiples Páginas) en VitePress para páginas sin JavaScript con mejor rendimiento inicial.
---
# Modo MPA <Badge type="warning" text="experimental" /> {#mpa-mode}
El modo MPA (Aplicación de multiples páginas) puede ser habilitado por la linea de comandos con `vitepress build --mpa`, o a través de la configuración por la opción `mpa: true`.

@ -1,4 +1,5 @@
---
description: Comprende el enrutamiento basado en archivos de VitePress, rutas dinámicas, URLs limpias y reescritura de rutas.
outline: deep
---

@ -1,3 +1,7 @@
---
description: Genera un archivo sitemap.xml para tu sitio VitePress para mejorar la visibilidad en motores de búsqueda.
---
# Generación de Sitemap {#sitemap-generation}
VitePress viene con soporte embutido para generar un archivo `sitemap.xml` para su sitio. Para habilitar, adicione lo siguiente a su `.vitepress/config.js`:

@ -1,4 +1,5 @@
---
description: Asegura que los componentes del tema y el código personalizado de VitePress sean compatibles con el renderizado del lado del servidor.
outline: deep
---

@ -1,3 +1,7 @@
---
description: Usa componentes Vue y funciones de plantillas dinámicas directamente dentro de archivos Markdown en VitePress.
---
# Usando Vue en Markdown {#using-vue-in-markdown}
En VitePress, cada archivo Markdown es compilado para HTML y entonces procesado como un [Componente de Archivo Único de Vue](https://vuejs.org/guide/scaling-up/sfc.html). Esto significa que puede usar cualquier funcionalidad de Vue dentro del Markdown, incluyendo la interpolación dinámica, usar componentes Vue o lógica arbitrária de componentes Vue dentro de la página adicionando una tag `<script>`.

@ -1,3 +1,7 @@
---
description: VitePress es un generador de sitios estáticos diseñado para crear sitios web rápidos y centrados en el contenido, impulsado por Vite y Vue.
---
# ¿Qué es VitePress? {#what-is-vitepress}
VitePress es un [Generador de Sitios Estáticos](https://en.wikipedia.org/wiki/Static_site_generator) (SSG) diseñado para construir sitios web rápidos y enfocados en el contenido. En pocas palabras, VitePress toma tu contenido fuente escrito en [Markdown](https://en.wikipedia.org/wiki/Markdown), le aplica un tema y genera páginas HTML estáticas que se pueden desplegar fácilmente en cualquier lugar.

@ -1,4 +1,5 @@
---
description: VitePress es un generador de sitios estáticos impulsado por Vite y Vue que te permite crear hermosos sitios de documentación a partir de Markdown.
layout: home
hero:

@ -1,3 +1,7 @@
---
description: Referencia de los comandos CLI de VitePress, incluyendo dev, build, preview e init.
---
# Intefaz de Linea de Comando {#command-line-interface}
## `vitepress dev`

@ -1,3 +1,7 @@
---
description: Usa el componente Badge para agregar etiquetas de estado a los encabezados en la documentación de VitePress.
---
# Badge {#badge}
Los Badge te permite agregar estados a tus encabezados. Por ejemplo, podría resultar útil especificar el tipo de sección o la version compatible.

@ -1,3 +1,7 @@
---
description: Integra Carbon Ads en tu sitio VitePress usando el soporte integrado del tema predeterminado.
---
# Carbon Ads {#carbon-ads}
VitePress ha incorporado soporte nativo para [Carbon Ads](https://www.carbonads.net/). Al definir las credenciales de Carbon Ads en la configuración, VitePress mostrará anuncios en la página.

@ -1,3 +1,7 @@
---
description: Referencia de todas las opciones de configuración disponibles para el tema predeterminado de VitePress.
---
# Configuración del Tema Predeterminado {#default-theme-config}
La configuración del tema te permite personalizar tu tema. puedes definir la configuración del tema a través de la opción `themeConfig` en el archivo de configuración:

@ -1,3 +1,7 @@
---
description: Muestra un enlace de edición en las páginas de documentación para permitir a los usuarios sugerir cambios en GitHub o GitLab.
---
# Editar Link {#edit-link}
## Configuración a nivel de sitio {#site-level-config}

@ -1,3 +1,7 @@
---
description: Configura el pie de página global que se muestra en la parte inferior de las páginas de VitePress.
---
# Pie de página {#footer}
VitePress mostrará un pie de página global en la parte inferior de la página cuando `themeConfig.footer` está presente.

@ -1,3 +1,7 @@
---
description: Configura el diseño de la página de inicio del tema predeterminado de VitePress con secciones hero, características y contenido personalizado.
---
# Página Inicial {#home-page}
El tema predeterminado de VitePress proporciona un diseño de página de inicio, que también puedes ver en uso [en la página de inicio de este sitio web](../). Puedes usarlo en cualquiera de sus páginas especificando `layout: home` en [frontmatter](./frontmatter-config).

@ -1,3 +1,7 @@
---
description: Muestra la marca de tiempo de la última actualización en las páginas de VitePress basada en el historial de commits de Git.
---
# Última Actualización {#last-updated}
La hora en que se actualizó el contenido por última vez se mostrará en la esquina inferior derecha de la página. Para habilitar, agregue la opción `lastUpdated` en su confirguración.

@ -1,3 +1,7 @@
---
description: Elige entre los layouts doc, page y home en el tema predeterminado de VitePress.
---
# Layout {#layout}
Puedes elegir el layout de la página definiendo una opción de `layout` para el [frontmatter](./frontmatter-config) De la página. Hay tres opciones de layout: `doc`, `page` y `home`. Si no se especifica nada, la página será tratada como una página. `doc`.

@ -1,3 +1,7 @@
---
description: Configura la barra de navegación en el tema predeterminado de VitePress, incluyendo el título del sitio, el logotipo y los enlaces del menú.
---
# Navegación {#nav}
Refiriéndose a la barra de navegación que se muestra en la parte superior de la página. Contiene el título del sitio, enlaces del menú global, etc.

@ -1,3 +1,7 @@
---
description: Personaliza los enlaces de página anterior y siguiente que se muestran en la parte inferior de las páginas de documentación en VitePress.
---
# Links Anterior y Próximo {#prev-next-links}
Puede personalizar el texto y el enlace de los botones Anterior y Siguiente que se muestran en la parte inferior de la página. Esto es útil cuando desea mostrar un texto diferente al que tiene en la barra lateral. Además, puede resultarle útil desactivar el pie de página o el enlace a la página para que no se incluya en la barra lateral.

@ -1,4 +1,5 @@
---
description: Configura la búsqueda local o con Algolia para tu sitio VitePress.
outline: deep
---

@ -1,3 +1,7 @@
---
description: Configura la navegación de la barra lateral en el tema predeterminado de VitePress con grupos, secciones colapsables y múltiples barras laterales.
---
# Barra Lateral {#sidebar}
La barra lateral es el bloque de navegación principal de su documentación. Puede configurar el menú de la barra lateral en [`themeConfig.sidebar`](./default-theme-config#sidebar).

@ -1,3 +1,7 @@
---
description: Crea páginas de equipo con perfiles de miembros usando los componentes de equipo integrados de VitePress.
---
<script setup>
import { VPTeamMembers } from 'vitepress/theme'

@ -1,4 +1,5 @@
---
description: Referencia de todas las opciones de configuración de frontmatter disponibles para páginas Markdown de VitePress.
outline: deep
---

@ -1,3 +1,7 @@
---
description: Referencia de las APIs en tiempo de ejecución de VitePress, incluyendo composables, funciones auxiliares y componentes integrados.
---
# API en Tiempo de Ejecución {#runtime-api}
VitePress ofrece varias API integradas para permitir el acceso a los datos de la aplicación. VitePress también viene con algunos componentes integrados que se pueden utilizar globalmente.

@ -1,4 +1,5 @@
---
description: Referencia completa de las opciones de configuración del sitio VitePress, incluyendo ajustes a nivel de aplicación, temas y opciones de compilación.
outline: deep
---

@ -1,3 +1,7 @@
---
description: نحوه ارجاع و مدیریت منابع ایستا مانند تصاویر، رسانه‌ها و فونت‌ها در ویت‌پرس.
---
# مدیریت منابع {#asset-handling}
## ارجاع به منابع ایستا {#referencing-static-assets}

@ -1,5 +1,6 @@
---
outline: deep
description: اتصال ویت‌پرس به یک سیستم مدیریت محتوای هدلس با استفاده از مسیرهای پویا و بارگذارهای داده.
---
# اتصال به یک سیستم مدیریت محتوا (CMS) {#connecting-to-a-cms}

@ -1,5 +1,6 @@
---
outline: deep
description: ایجاد و استفاده از تم سفارشی در ویت‌پرس برای کنترل کامل ظاهر و احساس سایت شما.
---
# استفاده از یک تم سفارشی {#using-a-custom-theme}

@ -1,3 +1,7 @@
---
description: بارگذاری داده‌های دلخواه در زمان ساخت با استفاده از بارگذارهای داده ویت‌پرس و وارد کردن آن‌ها در صفحات یا کامپوننت‌ها.
---
# بارگذاری داده در زمان ساخت {#build-time-data-loading}
ویت‌پرس یک ویژگی به نام **بارگذارهای داده** ارائه می‌دهد که به شما این امکان را می‌دهد که داده‌های دلخواه را بارگیری کنید و آن‌ها را از صفحات یا اجزا وارد کنید. بارگذاری داده فقط **در زمان ساخت** اجرا می‌شود: داده‌های حاصل به صورت JSON در بسته JavaScript نهایی سریالیزه می‌شوند.

@ -1,5 +1,6 @@
---
outline: deep
description: استقرار سایت ویت‌پرس خود بر روی پلتفرم‌های محبوب مانند Netlify، Vercel، GitHub Pages و سایر سرویس‌ها.
---
# استقرار وب‌سایت ویت‌پرس شما {#deploy-your-vitepress-site}

@ -1,5 +1,6 @@
---
outline: deep
description: سفارشی‌سازی و گسترش تم پیش‌فرض ویت‌پرس با CSS سفارشی، کامپوننت‌ها، طرح‌بندی‌ها و اسلات‌ها.
---
# گسترش تم پیش‌فرض {#extending-the-default-theme}

@ -1,3 +1,7 @@
---
description: نحوه استفاده از frontmatter YAML در فایل‌های Markdown ویت‌پرس برای کنترل متاداده و رفتار صفحه.
---
# Frontmatter
## استفاده {#usage}

@ -1,3 +1,7 @@
---
description: نصب و راه‌اندازی ویت‌پرس. یاد بگیرید چگونه سایت مستندات خود را نصب، ایجاد و توسعه دهید.
---
# شروع کار {#getting-started}
## تست آنلاین {#try-it-online}

@ -1,3 +1,7 @@
---
description: راه‌اندازی بین‌المللی‌سازی (i18n) در ویت‌پرس برای پشتیبانی از چندین زبان در سایت شما.
---
# بین‌المللی‌سازی {#internationalization}
برای استفاده از ویژگی‌های داخلی بین‌المللی‌سازی، نیاز است که یک ساختار دایرکتوری به شکل زیر ایجاد کنید:

@ -1,3 +1,7 @@
---
description: افزونه‌های داخلی Markdown در ویت‌پرس شامل کانتینرهای سفارشی، بلوک‌های کد با هایلایت، گروه‌های کد و موارد دیگر.
---
# افزونه‌های Markdown {#markdown-extensions}
ویت‌پرس با افزونه‌های markdown داخلی ارائه شده است.

@ -1,3 +1,7 @@
---
description: فعال‌سازی حالت MPA (برنامه چند صفحه) در ویت‌پرس برای صفحات بدون جاوااسکریپت با عملکرد اولیه بهتر.
---
# حالت MPA <Badge type="warning" text="آزمایشی" /> {#mpa-mode}
حالت MPA (برنامه چند صفحه) می‌تواند از طریق خط فرمان با `vitepress build --mpa` فعال شود، یا از طریق تنظیمات با گزینه `mpa: true`.

@ -1,5 +1,6 @@
---
outline: deep
description: آشنایی با مسیریابی مبتنی بر فایل، مسیرهای پویا، URLهای تمیز و بازنویسی مسیر در ویت‌پرس.
---
# مسیریابی {#routing}

@ -1,3 +1,7 @@
---
description: تولید فایل sitemap.xml برای سایت ویت‌پرس جهت بهبود قابلیت کشف توسط موتورهای جستجو.
---
# جنریت کردن Sitemap {#sitemap-generation}
ویت‌پرس با پشتیبانی بیرونی برای تولید فایل `sitemap.xml` برای سایت شما ارائه می‌شود. برای فعال‌سازی آن، موارد زیر را به فایل `.vitepress/config.js` خود اضافه کنید:

@ -1,5 +1,6 @@
---
outline: deep
description: اطمینان از سازگاری کامپوننت‌های تم و کد سفارشی ویت‌پرس با رندرینگ سمت سرور (SSR).
---
# تطابق SSR {#ssr-compatibility}

@ -1,3 +1,7 @@
---
description: استفاده از کامپوننت‌های Vue و قابلیت‌های قالب‌بندی پویا مستقیماً در فایل‌های Markdown ویت‌پرس.
---
# استفاده از Vue در Markdown {#using-vue-in-markdown}
در ویت‌پرس، هر فایل Markdown به HTML تبدیل شده و سپس به عنوان یک [کامپوننت فایل تکی Vue](https://vuejs.org/guide/scaling-up/sfc.html) پردازش می‌شود. این بدان معنی است که شما می‌توانید از هر ویژگی Vue در داخل Markdown استفاده کنید، شامل قالب‌بندی پویا، استفاده از کامپوننت‌های Vue، یا منطق کامپوننت Vue دلخواه در داخل صفحه با افزودن تگ `<script>`.

@ -1,3 +1,7 @@
---
description: ویت‌پرس یک تولیدکننده سایت ایستا برای ساخت وب‌سایت‌های سریع و محتوا محور با قدرت Vite و Vue است.
---
# ویت‌پرس چیست؟ {#what-is-vitepress}
ویت‌پرس یک [تولید کننده سایت ایستا](https://en.wikipedia.org/wiki/Static_site_generator) (SSG) است که برای ساخت وب‌سایت‌های سریع و محتوا محور طراحی شده است. به طور خلاصه، ویت‌پرس محتوای منبع شما که به زبان [Markdown](https://en.wikipedia.org/wiki/Markdown) نوشته شده است را گرفته، یک تم بر روی آن اعمال می‌کند و صفحات HTML ایستا تولید می‌کند که به راحتی در هر جایی قابل استقرار هستند.

@ -1,5 +1,6 @@
---
layout: home
description: ویت‌پرس یک تولیدکننده سایت ایستا مبتنی بر Vite و Vue است که به شما امکان ساخت سایت‌های مستندات زیبا از Markdown را می‌دهد.
hero:
name: ویت‌پرس

@ -1,3 +1,7 @@
---
description: مرجع دستورات CLI ویت‌پرس شامل dev، build، preview و init.
---
# رابط خط فرمان {#command-line-interface}
## `vitepress dev` {#vitepress-dev}

@ -1,3 +1,7 @@
---
description: استفاده از کامپوننت Badge برای افزودن برچسب‌های وضعیت به سرتیترها در مستندات ویت‌پرس.
---
# نشان {#badge}
برچسب به شما امکان می‌دهد وضعیت‌های مختلفی را به سربرگ‌های خود اضافه کنید. به عنوان مثال، می‌تواند مفید باشد تا نوع بخش را مشخص کنید یا نسخه‌های پشتیبانی شده را نشان دهید.

@ -1,3 +1,7 @@
---
description: یکپارچه‌سازی تبلیغات Carbon در سایت ویت‌پرس با استفاده از پشتیبانی داخلی تم پیش‌فرض.
---
# تبلیغات Carbon {#carbon-ads}
ویت‌پرس پشتیبانی داخلی برای [Carbon Ads](https://www.carbonads.net/) را دارد. با تعریف مشخصات تبلیغات Carbon در تنظیمات، ویت‌پرس تبلیغات را در صفحه نمایش می‌دهد.

@ -1,3 +1,7 @@
---
description: مرجع تمام گزینه‌های پیکربندی موجود برای تم پیش‌فرض ویت‌پرس.
---
# پیکربندی پیش‌فرض تم {#default-theme-config}
پیکربندی تم به شما امکان می‌دهد تا تم خود را سفارشی کنید. شما می‌توانید پیکربندی تم را از طریق گزینه `themeConfig` در فایل پیکربندی تعریف کنید:

@ -1,3 +1,7 @@
---
description: نمایش پیوند ویرایش در صفحات مستندات برای ارسال تغییرات پیشنهادی در GitHub یا GitLab.
---
# پیوند ویرایش {#edit-link}
## پیکربندی سطح سایت {#site-level-config}

@ -1,3 +1,7 @@
---
description: پیکربندی پاورقی سراسری که در پایین صفحات ویت‌پرس نمایش داده می‌شود.
---
# پاورقی {#footer}
وقتی `themeConfig.footer` حاضر باشد، ویت‌پرس پاورقی جهانی را در پایین صفحه نمایش می‌دهد.

@ -1,3 +1,7 @@
---
description: پیکربندی طرح صفحه اصلی تم پیش‌فرض ویت‌پرس با بخش‌های hero، ویژگی‌ها و محتوای سفارشی.
---
# صفحه اصلی {#home-page}
قالب پیش‌فرض ویت‌پرس یک طرح صفحه اصلی فراهم می‌کند که می‌توانید آن را همچنین در [صفحه اصلی این سایت](../) مشاهده کنید. شما می‌توانید آن را در هر یک از صفحات خود با تعیین `layout: home` در [frontmatter](./frontmatter-config) استفاده کنید.

@ -1,3 +1,7 @@
---
description: نمایش زمان آخرین بروزرسانی در صفحات ویت‌پرس بر اساس تاریخچه کامیت‌های Git.
---
# آخرین بروزرسانی {#last-updated}
زمان به روزرسانی آخرین محتوا در گوشه پایین سمت راست صفحه نمایش داده خواهد شد. برای فعال‌سازی آن، گزینه `lastUpdated` را به پیکربندی خود اضافه کنید.

@ -1,3 +1,7 @@
---
description: انتخاب بین طرح‌بندی‌های doc، page و home در تم پیش‌فرض ویت‌پرس.
---
# طرح بندی {#layout}
می‌توانید طرح صفحه را با تنظیم گزینه `layout` در [frontmatter](./frontmatter-config) صفحه انتخاب کنید. سه گزینه طرح وجود دارد، `doc`، `page` و `home`. اگر هیچ چیز مشخص نشده باشد، صفحه به عنوان صفحه `doc` در نظر گرفته می‌شود.

@ -1,3 +1,7 @@
---
description: پیکربندی نوار ناوبری در تم پیش‌فرض ویت‌پرس شامل عنوان سایت، لوگو و لینک‌های منو.
---
# ناوبری {#nav}
ناوبری نوار ناوبری است که در بالای صفحه نمایش داده می‌شود و شامل عنوان سایت، لینک‌های منوی جهانی، و غیره می‌باشد.

@ -1,3 +1,7 @@
---
description: سفارشی‌سازی پیوندهای صفحه قبلی و بعدی که در پایین صفحات مستندات ویت‌پرس نمایش داده می‌شوند.
---
# پیوندهای قبلی و بعدی {#prev-next-links}
شما می‌توانید متن و پیوند برای صفحات قبلی و بعدی را سفارشی‌سازی کنید (نمایش داده شده در پایین صفحه مستندات). این مفید است اگر می‌خواهید متن دیگری را در این قسمت نمایش دهید که با آنچه در نوار کناری دارید، متفاوت باشد. همچنین، ممکن است مفید باشد که فوتر را غیرفعال کنید یا به یک صفحه لینک کنید که در نوار کناری شما وجود ندارد.

@ -1,5 +1,6 @@
---
outline: deep
description: راه‌اندازی جستجوی محلی یا مبتنی بر Algolia برای سایت ویت‌پرس شما.
---
# جستجو {#search}

@ -1,3 +1,7 @@
---
description: پیکربندی نوار کناری ناوبری در تم پیش‌فرض ویت‌پرس با گروه‌ها، بخش‌های جمع‌شونده و چند نوار کناری.
---
# نوار کناری {#sidebar}
نوار کناری بلوک اصلی ناوبری برای مستندات شما است. شما می‌توانید منوی نوار کناری را در [`themeConfig.sidebar`](./default-theme-config#sidebar) پیکربندی کنید.

@ -1,3 +1,7 @@
---
description: ایجاد صفحات تیم با پروفایل اعضا با استفاده از کامپوننت‌های داخلی تیم ویت‌پرس.
---
<script setup>
import { VPTeamMembers } from 'vitepress/theme'

@ -1,5 +1,6 @@
---
outline: deep
description: مرجع تمام گزینه‌های پیکربندی frontmatter موجود برای صفحات Markdown ویت‌پرس.
---
# تنظیمات Frontmatter {#frontmatter-config}

Some files were not shown because too many files have changed in this diff Show More

Loading…
Cancel
Save