Aria Docs

ARIADOCS - Plantilla de documentación

Esta plantilla de documentación llena de características, construida con Next.js, ofrece un diseño elegante y receptivo, perfecto para todas sus necesidades de documentación de proyecto.

Aquí hay todas las versiones de la plantilla de AridoDocs, cada una creada para casos de uso específicos:

• Docios avanzados: una plantilla integral que ofrece características extensas para las necesidades de documentación en profundidad. Perfecto para proyectos más grandes que requieren explicaciones detalladas y configuraciones avanzadas.
  Explore los documentos avanzados

• Versión lite: una plantilla simplificada y sin lujos perfecta para necesidades de documentación sencillas.
  Explore la versión Lite

• Versión con versiones: una poderosa opción para proyectos que requieren un seguimiento de documentación histórica. Administre múltiples versiones de sus documentos sin esfuerzo.
  Mira la función de versiones

• Versión de soporte I18N (WIP): diseñada para audiencias internacionales, esta versión ofrecerá soporte multilingüe integral.
  Vista previa del soporte i18n

Comienzo rápido

Puede crear un nuevo proyecto ARIADOCS utilizando el comando:

 npx create-aria-doc <project-directory>

Salida esperada

Cuando ejecuta la CLI, puede esperar una salida similar a esta:

 Creating a new Ariadocs project in /path/to/your/project from the master branch...
Cloning Master (Full Documentation)...
Ariadocs project successfully created in /path/to/your/project!

Next steps:
1. Navigate to your project directory:
   cd <project-directory>
2. Install dependencies:
   // To support React 19, package maintainers will need to test and update their packages to include React 19 as a peer dependency. This is already in progress.
   npm install --force 
3. Start the development server:
   npm run dev

Empezando

Primero, ejecute el servidor de desarrollo:

 npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Desplegar en Vercel

La forma más fácil de implementar su aplicación Next.js es usar la plataforma Vercel de los creadores de Next.js.

Consulte nuestra documentación de implementación Next.js para obtener más detalles.

Características clave

Característica	Descripción
Soporte MDX	Escriba la documentación interactiva con MDX.
Páginas anidadas	Organizar contenido en una estructura jerárquica anidada.
Sección de blogs	Incluya una sección de blog dedicada.
Tabla de contenido	TOC generado automáticamente para una fácil navegación.
Paginación	Dividir contenido en varias páginas.
Destacación de sintaxis	Resaltar el código para una mejor legibilidad.
Destacación y títulos de la línea de código	Resaltar líneas específicas con títulos descriptivos.
Bloques de código interactivos	Visualización de código específico e interactivo del idioma.
Componentes personalizados	Incrustar componentes personalizables y reutilizables en sus documentos.
Modo Light & Dark	Alternar entre temas claros y oscuros.
Funcionalidad de búsqueda	Encuentre rápidamente contenido con una búsqueda incorporada.
Conmutador de código	Cambiar entre idiomas o variaciones de código.
Copia del código	Copie bloques de código con un solo clic.
Lo más destacado de TOC Observador	Resalte las secciones activas en el TOC mientras se desplaza.
Generación de sitios estático	Genere un sitio estático y de alto rendimiento.
SEO optimizado	Estructurado para la indexación óptima del motor de búsqueda.

Temas adicionales