681 - La mejor Wiki para organizar tus notas

Descubre An Otter Wiki, una wiki minimalista con Git y Markdown para organizar tus notas eficientemente. Ideal para documentación personal y colaborativa.

1:25

-3:15

0.8x1.0x1.2x1.4x1.6x1.8x2.0x

1.0x

De nuevo vuelvo al ataque con los servicios de notas, y se que no podrás resistirte a probarlo, porque es realmente sencillo, pero es justo lo que necesitas para organizar todo tu conocimiento y sin perder el tiempo. Y es que hace poco en el episodio 673 titulado Ocho imprescindibles para desarrolladores, te hablé de Docmost, como la herramienta para organizar todo tu conocimiento, un sitio donde guardar todos esos KB. Recientemente, me tropecé con An Otter Wiki, y no he tardado ni dos días en reemplazar al primero. Y la razón de reemplazarlo no ha sido ni mas ni menos que la simplicidad. Uno de los grandes obstáculos para documentar es utilizar una herramienta que te complica la vida. La herramienta que utilicemos para gestionar nuestro conocimiento tiene que ser sencilla, muy sencilla. Tiene que ser una herramienta que tengamos siempre a mano, y que podamos utilizar en cualquier momento. Y rápida, muy rápida, y estas son las características precisamente que tiene este servicio del que te voy a hablar en este episodio.

La mejor Wiki para organizar tus notas

¿Porque cambio de gestor documental?

La principal razón de cambiar de gestor documental, de pasar de Docmost a Otter Wiki, es por la velocidad y simplicidad del segundo frente al primero. En las últimas ocasiones que he intentado hacer algo con Docmost, o no cargaba el documento sobre el que quería trabajar o no lo encontraba. Lo cual, era un enorme inconveniente. Sin embargo, para lo que normalmente hago, no estaba mal. Pero tampoco bien.

Hace unos días, como te indicaba en la introducción, me tropecé con Otter Wiki, y entonces entendí, que la herramienta que estaba utilizando no era la adecuada. La rapidez, organización y sencillez de Otter estaba muy por encima, así que me decidí a integrarlo en mi flujo de trabajo.

An Otter Wiki

Al contrario de lo que te podrías pensar, An Otter Wiki, no está implementado en Rust. Se trata de un servicio que está implementado en Python para la gestión colaborativa de contenidos. Básicamente lo que se conoce como una Wiki. Si bien, está pensado en gestión colaborativa, tu puedes colaborar contigo mismo.

El contenido que realizas se guarda en un repositorio Git, lo que te pemitirá llevar un registro de todos los cambios que realizas. Y como no podía ser de otra forma, utilizarás Markdown, para crear tus contenidos.

Como curiosidad técnica, indicarte que utiliza el framework Flask de Python, Halfmoon para el CSS y CodeMirror como editor, mientras que Font Awesome es el que proporcional los iconos.

Indicarte que existe una demo de An Otter Wiki, para que puedas probarla y ver como funciona.

Características

Algunas de las características de esta auténtica Wiki son las siguientes,

• Interfaz minimalista (con modo oscuro).
• Editor con resaltado de sintaxis Markdown y soporte para tablas.
• Barra lateral personalizable: menú y/o índice de páginas.
• Historial completo de cambios y versiones de las páginas.
• Autenticación de usuarios.
• Adjuntos en las páginas.
• Markdown extendido: tablas, notas al pie, bloques estilizados, alertas y diagramas Mermaid.
• (Experimental) Servidor HTTP de Git: clonar, extraer y enviar cambios en el contenido del wiki.

Instalación

Como ya te puedes imaginar este servicio está disponible para ser auto alojado, una de las principales razones para traerlo aquí. En mi caso, el docker-compose.yml que he utilizado para convertirlo en mi gestor de contenidos por defecto ha sido el siguiente,

services:
  otterwiki:
    image: redimp/otterwiki:2
    container_name: otterwiki
    restart: unless-stopped
    init: true
    ports:
    - 8080:80
    volumes:
    - data:/app-data
    environment:
      SITE_NAME: "Atareao Wiki"
      DISABLE_REGISTRATION: True
      READ_ACCESS: "REGISTERED"
      WRITE_ACCESS: "REGISTERED"
    networks:
      - proxy
    labels:
      - traefik.enable=true
      - traefik.http.services.otterwiki.loadbalancer.server.port=80
      - traefik.http.routers.otterwiki.entrypoints=https
      - traefik.http.routers.otterwiki.rule=Host(`wiki.tusitio.es`)
volumes:
  data: {}
networks:
  proxy:
    external: true

Si te fijas, he añadido algunas variables de entorno un tanto peculiares, que te explico a continuación,

• DISABLE_REGISTRATION impide que otros usuarios se registren
• READ_ACCESS para que solo los usuarios registrados puedan tener acceso de lectura
• WRITE_ACCESS igual que en el caso anterior pero para el caso de la escritura.

El resto de parámetros mas o menos son los habituales y no he puesto nada extraño. Es de esos servicios que los pones a funcionar y funcionan a la primera, sin tener que hacer ingeniería inversa para saber como tiene que funcionar.

Otra cuestión curiosa es que la documentación sobre la instalación, configuración y personalización de este servicio se encuentra documentado utilizando este mismo servicio.

Configuración

Respecto a la configuración, yo te he indicado unas pocas variables de entorno, que son las que estoy utilizando actualmente, pero te puedo decir que tiene bastantes mas. En concreto tiene variables de entorno para,

• Modificar los detalles del sitio como pueden ser el nombre, icono y descripción.
• Cambiar la configuración de permisos
• Modificar las preferencias de la barra lateral
• Preferencias relativas al contenido y la edición
• Para gestionar el correo electrónico

Y algunos detalles mas

Ventajes e inconvenientes

Respecto a las ventajas te puedo indicar las siguientes,

• Es muy ligero y tremendamente fácil de instalar
• Te permite gestionar de forma perfecta las versiones gracias al uso de Git
• Utiliza el lenguaje de marcado mas ampliamente utilizado
• Es código abierto, liberado bajo licencia MIT

Pero no todo son ventajas, y algunas de ellas, se me hacen cuesta arriba,

• El que mas dolor me ocasiona es la gestión de imágenes. No me gusta como lo hace, lo convierte en algo difícil de manejar. Pero, como no suelo poner excesivas imágenes, por ahí me libro.
• El editor no es WYSIWYG (What You See Is What You Get), y eso es un inconveniente para muchos usuarios a los que el Markdown les da un poco de repelús.
• No tiene una gran comunidad detrás. Lo cual siempre es un inconveniente para la duración del proyecto.
• Tiene menos características si lo comparas con los grandes.
• No tiene cliente móvil. Pero aquí te tengo que decir que está implementado la interfaz adaptativa a las mil maravillas, así que no lo hecho en falta.

Conclusión

Si bien es un gestor documental que no tiene tantas opciones como los grandes, y no lo quiero comparar con Obsidian ni similares, la verdad es que tiene una gran ventaja que lo hace tremendamente competitivo frente al resto, que es su sencillez y rapidez, y te diría que en eso es posible que los gane a todos.

Más información,

• An Otter Wiki en GitHub