minimal

El tema mínimo

Minimal es un tema de Jekyll para páginas de GitHub. Puedes obtener una vista previa del tema para ver cómo se ve o incluso usarlo hoy.

Uso

Para usar el tema Mínimo:

1. Agregue lo siguiente al _config.yml de su sitio:

    remote_theme : pages-themes/[email protected]
   plugins :
   - jekyll-remote-theme # add this line to the plugins list if you already have one

2. Opcionalmente, si desea obtener una vista previa de su sitio en su computadora, agregue lo siguiente al Gemfile de su sitio:

    gem "github-pages" , group : :jekyll_plugins 

Personalización

Variables de configuración

Minimal respetará las siguientes variables, si se configuran en _config.yml de su sitio:

 title : [The title of your site]
description : [A short description of your site's purpose]

Además, puede optar por establecer las siguientes variables opcionales:

 show_downloads : ["true" or "false" (unquoted) to indicate whether to provide a download URL]
google_analytics : [Your Google Analytics tracking ID]

Hoja de estilo

Si desea agregar sus propios estilos personalizados:

1. Cree un archivo llamado /assets/css/style.scss en su sitio
2. Agregue el siguiente contenido al principio del archivo, exactamente como se muestra:

   ---
   ---
   
   @import " {{ site.theme }} " ;

3. Agregue cualquier CSS personalizado (o Sass, incluidas las importaciones) que desee inmediatamente después de la línea @import

Nota: Si desea cambiar las variables Sass del tema, debe establecer nuevos valores antes de la línea @import en su hoja de estilo.

Diseños

Si desea cambiar el diseño HTML del tema:

1. Para algunos cambios, como un favicon personalizado, puede agregar archivos personalizados en su carpeta _includes local. Los archivos proporcionados con el tema proporcionan un punto de partida y se incluyen en la plantilla de diseño original.
2. Para cambios más extensos, copie la plantilla original del repositorio del tema.
   ( Consejo profesional: haga clic en "sin formato" para facilitar la copia )
3. Cree un archivo llamado /_layouts/default.html en su sitio
4. Pegue el contenido del diseño predeterminado copiado en el primer paso
5. Personaliza el diseño como quieras

Personalización del código de Google Analytics

Google ha lanzado varias iteraciones de su código de Google Analytics a lo largo de los años desde que se creó este tema por primera vez. Si desea aprovechar el código más reciente, péguelo en _includes/head-custom-google-analytics.html en su sitio Jekyll.

Anulación de URL generadas por GitHub

Las plantillas a menudo dependen de las URL proporcionadas por GitHub, como enlaces a su repositorio o enlaces para descargar su proyecto. Si desea anular una o más URL predeterminadas:

1. Mire la fuente de la plantilla para determinar el nombre de la variable. Tendrá el formato {{ site.github.zip_url }} .
2. Especifique la URL que desea que utilice la plantilla en _config.yml de su sitio. Por ejemplo, si la variable fuera site.github.url , agregaría lo siguiente:

    github :
     zip_url : http://example.com/download.zip
     another_url : another value

3. Cuando se cree su sitio, Jekyll usará la URL que especificó, en lugar de la predeterminada proporcionada por GitHub.

Nota: Debe eliminar el site. prefijo, y cada nombre de variable (después de github. ) debe tener una sangría con dos espacios debajo de github: .

Para obtener más información, consulte la documentación de variables de Jekyll.

Hoja de ruta

Consulte los problemas abiertos para obtener una lista de funciones propuestas (y problemas conocidos).

Filosofía del proyecto

El tema Minimal está destinado a hacer que a los usuarios de GitHub Pages les resulte rápido y fácil crear su primer (o número 100) sitio web. El tema debe satisfacer la gran mayoría de las necesidades de los usuarios desde el primer momento, prefiriendo la simplicidad en lugar de la flexibilidad, y brindar a los usuarios la oportunidad de optar por una complejidad adicional si tienen necesidades específicas o desean personalizar aún más su experiencia. (como agregar CSS personalizado o modificar el diseño predeterminado). También debería verse genial, pero eso es evidente.

Contribuyendo

¿Interesado en contribuir a Minimal? Nos encantaría tu ayuda. Minimal es un proyecto de código abierto, creado una contribución a la vez por usuarios como usted. Consulte el archivo CONTRIBUCIÓN para obtener instrucciones sobre cómo contribuir.

Vista previa del tema localmente

Si desea obtener una vista previa del tema localmente (por ejemplo, en el proceso de proponer un cambio):

1. Clona el repositorio del tema ( git clone https://github.com/pages-themes/minimal )
2. cd en el directorio del tema
3. Ejecute script/bootstrap para instalar las dependencias necesarias
4. Ejecute bundle exec jekyll serve para iniciar el servidor de vista previa
5. Visita localhost:4000 en tu navegador para obtener una vista previa del tema

Ejecución de pruebas

El tema contiene un conjunto de pruebas mínimo para garantizar que un sitio con el tema se cree correctamente. Para ejecutar las pruebas, simplemente ejecute script/cibuild . Deberá ejecutar script/bootstrap una vez antes de que funcione el script de prueba.