yamblg

README

[comment]
!Leandro Avila leandroav.dev@gmail.com

:fecha: 02/05/2026
:project-version: 0.1.12
:badge-url: https://img.shields.io/badge/Version-{project-version}-blue?style=flat-square

ifdef::env-github[]
++++
<p align="center">
  <img src="logo.png" alt="Yamblg Logo" width="max-content">
</p>
++++
endif::[]

Diseñado para quienes quieren un blog rápidamente. Instalas la herramienta, creas tus YAML y generas el blog.

[.text-center]
image:https://img.shields.io/badge/Status-Active-brightgreen?style=flat-square[Status]
image:https://img.shields.io/badge/go-v1.25+-00ADD8?style=flat-square&logo=go&logoColor=white[Go Version]
image:https://img.shields.io/badge/Config-YAML-red?style=flat-square&logo=yaml&logoColor=white[Config]
image:{badge-url}[Version]
image:https://pkg.go.dev/badge/github.com/l3anav/mirtura.svg[https://pkg.go.dev/github.com/l3anav/mirtura]
image:https://img.shields.io/badge/RSS-Feed-orange?style=flat-square&logo=rss[RSS Feed, link="https://l3anav.github.io/Yamblg/index.xml"]


== 🚀 [.underline]#¿Cómo se usa?#

### 0. Requisitos previos
[WARNING]
====
**¡OJO!** Para utilizar Yamblg, necesitas tener instalado **Go** en tu sistema (versión >= 1.25). Puedes descargarlo desde link:https://go.dev/dl/[go.dev].
====

### 1. Instalación
Una vez tengas Go configurado, instala el CLI de Yamblg ejecutando:
[source,bash]
----
go install github.com/l3anav/yamblg@latest
----

### 2. Comandos principales

* **`yamblg init`**: Genera un template inicial con la estructura de carpetas y archivos base para tu blog.
* **`yamblg serve`**: Levanta un servidor local en memoria. Perfecto para desarrollo: puedes cambiar estilos o redactar posts y ver los cambios al instante sin regenerar archivos.
* **`yamblg build`**: (Opcional) Procesa todo el contenido y genera la carpeta `public/` con el sitio estático final, listo para subir a producción.

---

[WARNING]
====
**¡OJO!** Si despliegas en GitHub Pages, recuerda ir a los ajustes de tu repositorio, sección **PAGES**, y seleccionar **GitHub Actions** como fuente del despliegue.
====

ifdef::env-github[]
++++
<details>
  <summary>📸 Muestra de donde está la configuración</summary>
++++
image::github-actions.gif[Configuración de Actions]
++++
</details>
++++
endif::[]

### 3. Configura tus posts
Crea archivos del estilo `{name}.yaml`. Si el campo `title` está vacío, el sistema usará el nombre del archivo.

[source,text]
title: <Titulo de la entrada de blog>
date: Completa automaticamente con la fecha de creación o modificación del archivo (si el campo está vacío).
fijado: true | false -> Se muestra en home resaltado. 
author: <Quien escribe la entrada>
description: <Resumen de contenido de la entrada>
body: <Contenido de la entrada en Markdown o texto plano>

.Ejemplo de "mi-primer-post.yaml":
[source,yaml]
----
title: "Hola, Bienvenido a Yamblg!"
date: "22-01-2026"
fijado: false
author: "!Leandro Avila"
description: "Primer post creado para mostrar la potencia del CLI."
body: "Bienvenido a la demo de Yamblg. ¡Gracias por usar la herramienta!"
----

=== Config.yaml

[source,yaml]
----
baseUrl: "/nombre-repo" # El nombre de tu repositorio en GitHub
siteTitle: "Yamblg | Mi Blog"
useSectionPost: 
    active: true
    limitOfPost: 5 
    method: "Latest"
usePinned: 
    active: true
----

## ⚙️ Cómo funciona

xref:.docs/estructura.adoc[Detalle de estructura de proyecto]

Desarrollado para la simplicidad.

**¡Go publish!**

Última Actualización de documento:
{fecha}