gozer

¡Gozer!

Gozer es un generador de sitios estáticos rápido y sencillo escrito en Golang.

• Convierte Markdown a HTML.
• Le permite utilizar plantillas específicas de la página.
• Crea un mapa del sitio XML para motores de búsqueda.
• Crea una fuente RSS para lectores de fuentes.

Sitios web de muestra que utilizan Gozer:

• El ejemplo más simple posible
• Mi sitio web personal: sitio - fuente

Instalación

Puede instalar Gozer instalando primero un compilador de Go y luego ejecutando:

go install git.sr.ht/~dvko/gozer@latest

Uso

Ejecute gozer new para generar rápidamente una estructura de directorio vacía.

├── config.toml                # Configuration file
├── content                    # Posts and pages
│   └── index.md
├── public                     # Static files
└── templates                  # Template files
    └── default.html

Luego, ejecute gozer build para generar su sitio.

Cualquier archivo Markdown colocado en su directorio content/ dará como resultado una página HTML en su directorio de compilación después de ejecutar gozer build .

Por ejemplo:

• content/index.md crea un archivo build/index.html para que sea accesible a través de HTTP en /
• content/about.md crea un archivo build/about/index.html para que sea accesible a través de HTTP en /about/ .

Comandos

Ejecute gozer sin ningún argumento para ver el texto de ayuda.

 Gozer - a fast & simple static site generator

Usage: gozer [OPTIONS] <COMMAND>

Commands:
    build   Deletes the output directory if there is one and builds the site
    serve   Builds the site and starts an HTTP server on http://localhost:8080
    new     Creates a new site structure in the given directory

Options:
    -r, --root <ROOT> Directory to use as root of project (default: .)
    -c, --config <CONFIG> Path to configuration file (default: config.toml)

Archivos de contenido

Cada archivo en su directorio content/ debe terminar en .md y tener un texto frontal TOML que especifique el título de la página:

 +++
title = " My page title "
+++

Page content here.

Plantillas

La plantilla predeterminada para cada página es default.html . Puede anularlo configurando la variable template en su portada.

 +++
title = " My page title "
template = " special-page.html "
+++

Page content here.

Las plantillas funcionan con el paquete html/template estándar de Go, por lo que puede utilizar todas las acciones que se describen aquí.

Cada plantilla recibe el siguiente conjunto de variables:

 Pages       # Slice of all pages in the site
Posts       # Slice of all posts in the site (any page with a date in the filename)
Site        # Global site properties: Url, Title
Page        # The current page: Title, Permalink, UrlPath, DatePublished, DateModified
Title       # The current page title, shorthand for Page.Title
Content     # The current page's HTML content.

La variable Page es una instancia del siguiente objeto:

 type Page struct {
    // Title of this page
    Title         string

    // Template this page uses for rendering. Defaults to "default.html".
    Template      string

    // Time this page was published (parsed from file name).
    DatePublished time.Time

    // Time this page was last modified on the filesystem.
    DateModified  time.Time

    // The full URL to this page, including the site URL.
    Permalink     string

    // URL path for this page, relative to site URL
    UrlPath       string

    // Path to source file for this page, relative to content root
    Filepath      string
}

Para mostrar una lista de las 5 publicaciones más recientes:

 {{ range (slice .Posts 0 5) }}
    <a href="{{ .Permalink }}">{{ .Title }}</a> <small>{{ .DatePublished.Format "Jan 02, 2006" }}</small><br />
{{ end }}

Contribuyendo

El desarrollo de Gozer ocurre en Sourcehut. Los parches se aceptan por correo electrónico.

• repositorio de código
• lista de correo
• Rastreador de problemas

Licencia

Gozer es de código abierto bajo la licencia del MIT.