just-the-docs/just-the-docs

¿Qué es?

Funciones clave

• 01Navegación en una barra lateral para páginas de documentación con varios niveles
• 02Búsqueda integrada del lado del cliente
• 03Diseño adaptable y una experiencia optimizada para móviles
• 04Funciona en GitHub Pages con pocas dependencias y sin un script de compilación
• 05Disponible como Ruby gem o mediante una plantilla de sitio lista para usar

Casos de uso

• Publicar documentación de proyectos o referencias de API en GitHub Pages
• Crear con Jekyll un sitio de productos o una base de conocimientos interna con función de búsqueda
• Crear rápidamente un sitio de documentación a partir de una plantilla

Inicio rápido

1. 1

   Añade la gema al Gemfile de tu sitio Jekyll

   gem "just-the-docs"
2. 2

   Configura el tema en el _config.yml de tu sitio

   theme: just-the-docs
3. 3

   Instala todas las dependencias

   bundle
4. 4

   Inicia el servidor local y abre http://localhost:4000

   bundle exec jekyll serve

Antes de usarlo

• !Para ejecutarlo localmente, necesitas un sitio Jekyll y un entorno Ruby.

Temas

Preguntas frecuentes

¿Qué es just-the-docs?

Un tema Jekyll personalizable y adaptable para sitios de documentación, con búsqueda integrada y fácil de alojar en GitHub Pages. Just the Docs es un tema Jekyll para crear sitios web de documentación. Ofrece un diseño con navegación en una barra lateral, búsqueda integrada y un diseño adaptable pensado para funcionar bien en dispositivos móviles.

¿just-the-docs es gratuito? ¿Qué licencia tiene?

just-the-docs es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.

¿just-the-docs sigue mantenido?

Mantenimiento activo. El último commit de just-the-docs fue el 21 oct 2026.

¿Para qué puedo usar just-the-docs?

Publicar documentación de proyectos o referencias de API en GitHub Pages Crear con Jekyll un sitio de productos o una base de conocimientos interna con función de búsqueda Crear rápidamente un sitio de documentación a partir de una plantilla

¿Cómo se instala just-the-docs?

Añade la gema al Gemfile de tu sitio Jekyll: gem "just-the-docs" Configura el tema en el _config.yml de tu sitio: theme: just-the-docs Instala todas las dependencias: bundle Inicia el servidor local y abre http://localhost:4000: bundle exec jekyll serve

¿Dónde consigo just-the-docs?

El código fuente y las instrucciones de instalación están en GitHub: https://github.com/just-the-docs/just-the-docs