Sobre el proyecto
Just the Docs es un tema de Jekyll moderno, altamente personalizable y adaptable diseñado para crear sitios web de documentación. Cuenta con búsqueda integrada y está diseñado para alojarse fácilmente en GitHub Pages con dependencias mínimas.
Las características y detalles clave del README incluyen:
- **Instalación sencilla**: Se puede configurar rápidamente usando la 'Just the Docs Template' para GitHub Pages, o instalarse como una gema de Ruby añadiéndola al `Gemfile` y estableciendo `theme: just-the-docs` en el `_config.yml` de Jekyll.
- **Principios de diseño**: Se enfoca en tener la menor cantidad posible de dependencias, no requiere script de compilación, ofrece una experiencia móvil de primer nivel y mantiene el enfoque directamente en el contenido.
- **Desarrollo y personalización**: Los usuarios pueden bifurcar el repositorio, ejecutar `bundle install` y usar `bundle exec jekyll serve` para previsualizar los cambios localmente. Solo los archivos en `_layouts`, `_includes` y `_sass` se empaquetan en la gema.
- **Contribución y licencia**: Código abierto bajo la Licencia MIT, acepta informes de errores, propuestas de funcionalidades y solicitudes de extracción que cumplan con el código de conducta del Contributor Covenant.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.