A continuación se explica cómo instalar SiteFab, crear un nuevo sitio y compilarlo en menos de 30 segundos:
# install the main package
pip install sitefab
spacy download en_core_web_sm
pip install -U spacy-lookups-data
# clone the site template as base
git clone https://github.com/ebursztein/sitefab-template.git mysite/
# clone the plugins in your site directory
git clone https://github.com/ebursztein/sitefab-plugins.git mysite/plugins
# generate your shiny new site
sitefab -c mysite/config/sitefab.yaml generate
¡Y listo! Sabes que tienes un sitio completamente funcional que se puede compilar estáticamente. Como siguiente paso, debes agregar tu contenido, personalizar las plantillas html y modificar la configuración de los complementos a tu gusto.
Estas son algunas de las funcionalidades clave de alto nivel que hacen de SiteFab el generador estático preferido para los sitios web modernos:
<picture>
, versiones webp para los navegadores que lo admiten, miniatura congelada para la carga. y miniaturas recortadas para vistas previas.Además de sus características técnicas, lo que separa a SiteFab de otros generadores de sitios son sus principios rectores:
Configuración sobre convención : cada comportamiento se especifica explícitamente. No hay archivos ni directorios especiales. SiteFab solo hace lo que dice la configuración del sitio. Nada más, nada menos.
Agnóstico de contenido : solo existe un tipo de contenido llamado publicación. SiteFab no hace ninguna suposición sobre el contenido almacenado en los archivos .md. Su trabajo es aplicar la configuración especificada en el frontmatter para representar los archivos específicos y garantizar que los complementos habilitados se ejecuten correctamente.
Atomicidad : cada pieza de contenido es autónoma al tener su propia configuración en su interfaz, incluida qué plantilla usar. Esto permite acomodar tanto sitios complejos con configuración por página como sitios muy simples que reutilizan la misma plantilla una y otra vez.
Ortogonalidad : la configuración del sitio, los complementos y la configuración de complementos son independientes del motor central, por lo que puede usar tantas configuraciones y complementos modificados como desee. Además, puede verificarlos junto con el contenido de su sitio para que tengan una compilación reproducible, reversiones seguras y una versión simultánea del proceso de compilación (por ejemplo, alfa versus estable).
Aquí hay algunas alternativas populares si SiteFab no es lo que busca:
Jekyll: El sitio más popular generado, escrito en Ruby
.
Hugo: un generador de sitios popular, escrito en Go
y que se centra en la velocidad.
Pelican: Otro generador de sitios escrito en Python
.