Jekyll más simple
Un sitio mínimo basado en Jekyll en las páginas de GH, reducido a una página de contenido con un tema
Avance
Acerca de
Este es una plantilla y un proyecto de demostración en vivo. Muestra lo poco que necesita configurar para obtener un sitio de Jekyll en las páginas de GH.
- índice.md
- Para la página de inicio, la única página en este caso.
- Si deja de lado esta página, entonces
README.md se usará como su página de inicio.
- _config.yml
- Establezca el tema, que maneja el diseño y el estilo.
- Enable Jekyll Sitemap Plugin: habilitarlo en Gemfile no es suficiente. Tenga en cuenta que otros complementos estarán habilitados para usted, como una zanja opcional.
- Otros valores estándar como
baseurl , title y description se han dejado fuera de la configuración. Al construir en páginas de GH, las páginas GH inferirán para usted.
- Filo
- Esto no es utilizado en realidad por las páginas de GH, pero le permite instalar el tema de Jekyll localmente usando Bundler.
- Use una sola gema
github-pages si desea que coincida con todas las gemas en las páginas de GH (que pueden ser pesadas para instalar). - Elimine este archivo si no necesita ejecutar su sitio localmente.
Si desea un ejemplo más completo de un sitio de múltiples páginas con publicaciones, gemas, diseños, etc., consulte mi repositorio Jekyll-Blog-Demo. Eso también se puede usar como plantilla y sitio de demostración.
Cómo usar este proyecto
Configuración
- Haga clic en Use esta plantilla para crear un nuevo repositorio en su propia cuenta. Puedes dejar el nombre como
simplest-jekyll . - Habilite las páginas de GitHub en la configuración de su repositorio. Elija servir desde la rama
master y la opción / ruta. - Consulte la pestaña de entorno de su repositorio para ver cuándo está listo el despliegue.
- Haga clic en Ver implementación para ver el sitio en vivo. por ejemplo, https://michaelcurrin.github.io/simplest-jekyll/
Tenga en cuenta que /simplest-jekyll/index.html está disponible de inmediato, pero tarda unos minutos hasta que GitHub Pages realiza /simplest-jekyll/ disponible.
Personalizar
- Actualice el
README.md con sus propios detalles. Esto no se usa realmente en el sitio implementado, pero es visible localmente y en GitHub. - Temas
- Edite el tema en _config.yml si desea otro tema.
- También puede usar la sección de páginas GitHub de la configuración de repo para obtener una vista previa visualmente.
- Tenga en cuenta solo los temas admitidos por las páginas GitHub (aproximadamente 10), pero si usa el campo Remote_theme en su configuración, puede hacer referencia a más temas.
- Para instalar y ejecutar localmente, deberá asegurarse de que su archivo de Gem cubra el tema utilizado en la configuración.
- Como con la mayoría de los sitios de Jekyll, el index.md se usa como página de inicio.
- Tiene materia frontal en la parte superior, por lo que se aplicará cualquier líquido.
- Edite su archivo
index.md con su propio contenido como HTML o Markdown. - Puede cambiar el nombre de
index.html si solo desea HTML simple. - Puede eliminar la materia frontal en la parte superior para eliminar el formato de líquido y cualquier temática.
- Si lo desea, agregue más páginas en la raíz y rompa cualquier HTML común, como el encabezado o la cabeza o la barra de navegación en la carpeta
_includes la carpeta o _layouts (ninguno de los dos está cubierto en el alcance de este proyecto, pero son comunes para los proyectos de Jekyll). - Vea los documentos y tutoriales en el sitio de Jekyll para obtener más información.
- Opcionalmente ejecuta Jekyll localmente:
- Instale Ruby y Bundler.
- Instale Gems del Proyecto - Jekyll y The Theme Gem.
- Ejecute el servidor Jekyll Dev.
- Para obtener instrucciones más completas, consulte Docios de Blog de Jekyll. Deberá agregar un
Makefile también para que coincida con esos comandos.
Proyectos relacionados
- - Blog predeterminado generado con Jekyll CLI. Usando un tema, contenido, configuración de estilo, gemas y un makefile.
- - Uso de Jekyll 4, un tema, acciones de GitHub y páginas GitHub.
- - Sitio de Jekyll mínimo con un tema pero sin Gemfile.
Licencia
Lanzado bajo MIT por @MichaelCurrin.
