just the docs
v0.10.0
Un tema Jekyll moderno, altamente personalizable y responsivo para documentación con búsqueda integrada.
Alojado fácilmente en páginas de GitHub con pocas dependencias.
¡Véalo en acción!
Un tutorial en vídeo de varias funciones de Just the Docs
La plantilla Just the Docs proporciona la forma más sencilla, rápida y sencilla de crear un nuevo sitio web que utilice el tema Just the Docs. Para comenzar a crear un sitio, simplemente haga clic en "usar la plantilla".
Nota: Para usar el tema, no es necesario clonar ni bifurcar el repositorio Just the Docs. Debe hacerlo solo si tiene la intención de explorar los documentos del tema localmente, contribuir al desarrollo del tema o desarrollar un nuevo tema basado en Just the Docs.
Puede configurar fácilmente el sitio creado por la plantilla para que se publique en GitHub Pages; el archivo README de la plantilla explica cómo hacerlo, junto con otros detalles.
Si Jekyll está instalado en su computadora, también puede crear y obtener una vista previa del sitio creado localmente . Esto le permite probar los cambios antes de realizarlos y evita tener que esperar a las páginas de GitHub. 1 Y podrá implementar su compilación local en una plataforma diferente a GitHub Pages.
Más específicamente, el sitio creado:
Gemfile y carga la gema just-the-docs Aparte de eso, eres libre de personalizar los sitios que crees con la plantilla, como quieras. Puede cambiar fácilmente las versiones de just-the-docs y Jekyll que utiliza, además de agregar más complementos.
Alternativamente, puede instalar el tema como Ruby Gem, sin crear un sitio nuevo.
Agregue esta línea al Gemfile de su sitio Jekyll:
gem "just-the-docs" Y agregue esta línea al _config.yml de su sitio Jekyll:
theme : just-the-docsY luego ejecuta:
$ bundle
O instálelo usted mismo como:
$ gem install just-the-docs
Alternativamente, puede ejecutarlo dentro de Docker mientras desarrolla su sitio.
$ docker-compose up
Vea la documentación para obtener información de uso.
Los informes de errores, las propuestas de nuevas funciones y las solicitudes de extracción son bienvenidos en GitHub en https://github.com/just-the-docs/just-the-docs. Este proyecto pretende ser un espacio seguro y acogedor para la colaboración, y se espera que los contribuyentes cumplan con el código de conducta del Pacto de Colaboradores.
Para configurar su entorno para desarrollar este tema: bifurque este repositorio y ejecute la bundle install desde el directorio raíz.
Se incluye una configuración de contenedor de desarrollo moderna para VSCode.
¡Tu tema está configurado como un sitio Jekyll normal! Para probar su tema, ejecute bundle exec jekyll serve y abra su navegador en http://localhost:4000 . Esto inicia un servidor Jekyll usando su tema. Agregue páginas, documentos, datos, etc. como de costumbre para probar el contenido de su tema. A medida que realiza modificaciones en su tema y contenido, su sitio se regenerará y debería ver los cambios en el navegador después de una actualización, como de costumbre.
Cuando se lance este tema, solo los archivos en _layouts , _includes y _sass rastreados con Git se incluirán en la gema.
El tema está disponible como código abierto según los términos de la licencia MIT.
Los cambios en su sitio pueden tardar hasta 10 minutos en publicarse después de enviarlos a GitHub. ↩
