¿Qué es WikiTerra ?
WikiTerra es una pequeña enciclopedia web del modelo cosmológico terrestre gestionada entera sobre una bóveda o baúl de artículos desde el gestor de notas Obsidian.md.
Web estática
Wikiterra es una web estática, lo que significa que no hay lado servidor todo se ejecuta en lado cliente (en el navegador web, "chrome", "firefox", etc). Los artículos están escritos en formato markdown, un lenguaje de marcado sencillo y fácil de leer, que se convierte al formato web (HTML, CSS, JS) usando un Generador de sitios estáticos (SSG).
Hay cientos de generadores estáticos en JamStack clasifican 355, algunos de los más importantes son: Next.js, HUGO, Docusaurus, Nuxt, Astro, Jekyll, GitBook, Docsify, VuePress, MkDocs, Eleventy.
Cada SSG uno tiene su propio lenguaje de programación con su propio estilo de plantillas para ser transformados a formato web. Pero al final lo que importa es la plantilla que uses y que el framework o SSG sea intuitivo, tenga una gran comunidad y se mantenga en desarrollo.
En el caso de Wikiterra, la web ha sido testeada en local con diferentes SSG como HUGO con el tema Hextra, Astro con el tema Starlight, o Tiddlywiki con el tema Featherwiki que permite tener un web entera sobre un único HTML.
Sin embargo la opción que se ha mantenido ha sido la plantilla web de Digital Garden de Ole Eskild que usa 11Ty como generador, por su bonito diseño y su fácil uso através de Obsidian.
Creación de la web con Digital Garden
Wikiterra se basa la plantilla web Digital Garden de Ole Eskild que utiliza 11Ty como generador de sitios estáticos (SSG)
Para configurar la web es necesario realizar los siguientes pasos:
- Primero tenemos que tener instalado obsidian y nuestro vault de notas abierto.
- Tener una cuenta en una plataforma de git (GitHub, GitLab, Codeberg, etc).
- Instalar el plugin para Obsidian Digital Garden Publication Center, y configurar el nombre de usuario, repositorio y token de la plataforma de git.
- Clonar la plantilla de Digital Garden para hospedar la plantilla con el contenido y configurar el proveedor de alojamiento de sitios estáticos para **desplegar la webgenerada **, puede ser: Cloudflare Pages, GitHub Pages, GitLab Pages, Netlify, Vercel.
- Y configurar el proceso de despliegue, para GitHub Pages con GitHub actions en
.github/workflows/build.yml
, para Vercel envercel.json
, para Netlify ennetlify.toml
, etc.
En el caso de WikiTerra es lo siguiente:
- Se escribe en formato markdown en obsidian.md.
- Se publica el contenido con el plugin de Obsidian Digital Garden Publication Center que sincroniza los archivos con el la plantilla web WikiTerra/wikiterra.github.io en GitHub.
- Se despliega la web usando "flujos de trabajo de GitHub Actions" configurado en
.github/workflows/build.yml
que hacen uso de 11Ty programado en la plantilla.
npm install # instalar paquetes de node.js
npm run build # construir web
npm run watch:eleventy # visualizar web, alternativas "npm run start" o "npx @11ty/eleventy --serve"
Para más información visitar la documentación oficial, Digital Garden Docs.
Pros vs contras
-
Ventajas (pros)
- El conjunto de notas markdown se encuentra indexado en una bóveda con los gestores de conocimiento (PKM) como Obsidian.md.
- Permite enlazar artículos de manera sencilla y ver su relación en un grafo.
- El contenido está en local en tu propia máquina.
-
Desventajas (contras)
- Requiere conocer la sintaxis markdown.
- El lenguaje markdown varía según la aplicación, no tiene un estándar fijo.
- Los navegadores web solo leen HTML (junto con CSS y JS), para visualizar markdown con formato se necesita un conversor (como hace obsidian, vscode y otros).
¿Cómo editar?
Para editar la wiki consulta la sección de wikiterra-edicion.