Guía Markdown de Wiki.js

Wiki.js es una aplicación open source con la que crear Wikis. Es muy utilizada a la hora de crear documentaciones o fuentes de información acerca de ciertos productos o servicios.

Acerca de Wiki.js

Wiki.js es una herramienta usadada tanto por usuarios individuales como por equipos o empresas. Para usar Wiki.js necesitarás instalarl la aplicación en un servidor y configurar una base de datos.

Wiki.js dispone de un excelente soporte de Markdown. Podrás activar Pandoc, pudiendo así realizar conversiones entre múltiples versiones de Markdown e incluso desde la sintaxis AsciiDoc. También podrás configurar varias funcionalidades de Markdown o cómo se renderizarán los elementos.

Podrás instalar Wiki.js en Linux, macOS o en Windows. También dispone de contenedores Docker y Kubernetes. En cuanto a bases de datos, soporta PostgreSQL, MySQL, MariaDB, SQL Server y SQLite. Wiki.js viene con autenticación de dos factores opcional, pudiendo también acceder usando cuantas de servicios como Google, Microsoft, GitHub, Slack o Discord. Podrás agregar varios usuarios y gestionarlos, creando grupos o asignándoles permisos o reglas.

Wiki.js no se limita a Markdown, soportando también editores WYSIWYG o HTML. Dispone de herramientas para crear tablas y mucho más. Se trata de una herramienta muy usada para documentar APIs, disponiendo de un sistema con el que agregar endpoints, parámetros, peticiones o ejemplos con respuestas. También incluye una librería con la que agregar imágenes, archivos o vídeos.

En cuanto a la redacción de documentos, con Wiki.js podrás crear diagramas de difentes tipos, incluyendo diagramas UML. Soporta expresiones matemáticas TeX y MathML, además de permitirte agregar bloques de código y resaltar la sintaxis del lenguaje que uses.

Wiki.js incluye un sistema de búsqueda, integrándose también con Elasticsearch, Algolia, Azure Search y muchos otros motores de búsqueda como Solr, o Sphinx. En cuanto al almacenamiento de archivos, dispone de integraciones con AWS S3, Azure Blob, Digital Ocean Spaces, Dropbox o Google Cloud Storage, entre otras soluciones.

Podrás hacer un seguimiento de tus documentos, ya que Wiki.js dispone de un sistema de control de versiones, pudiendo también compararlas o crear versiones heredadas. También podrás sincronizar tu wiki con GitHub, GitLab, BitBucket o Azure DevOps, entre otros servicios de gestión de repositorios.

Wiki.js dispone de una gran cantidad de módulos, integrándose con Google Analytics, Fathom Analytics, Yandex, Metrica, Google Tag manager, New Relic, HotJar, Firebase, Okta, Slack, Sentry y un sinfín de servicios.

Wiki.js está disponible en múltiples idiomas, incluyendo lenguages RTL. También dispone de múltiples temas por defecto con los que personalizar tu Wiki, además de darte la opción de crear tu propio tema.

Instalación de Wiki.js

Para instalar Wiki.js basta con que accedas a la guía de instalación de Wiki.js y sigas las instrucciones que se muestran, según tu sistema operativo. Necesitarás tener Node.js instalado en tu sistema. Si no lo tienes, instalado, consulta el tutorial de instalación de Node.js.

Instalación de Wiki.js en Linux

Si no has instalado Node.js todavía, puedes consultar cómo instalar Node.js en Ubuntu o cómo instalar Node.js en CentOS. Para instalar Wiki.js en Linux tendrás que descargar primero su paquete usando wget:

wget https://github.com/Requarks/wiki/releases/latest/download/wiki-js.tar.gz

Luego extrae el paquete descargado a un directorio:

mkdir wiki
tar xzf wiki-js.tar.gz -C ./wiki
cd ./wiki

Seguidamente, renombra el archivo config.sample.yml a config.yml:

mv config.sample.yml config.yml

Luego edita el archivo de configuración y configura los datos de acceso a la base de datos y el puerto. Por ejemplo:

port: 3000
db:
  type: mysql
  host: localhost
  port: 3306
  user: admin
  pass: tupass
  db: wikijs

Finalmente usa el siguiente comando para iniciari el servidor node:

node server

Instalación de Wiki.js en macOs

Antes de comenzar, asegúrate de que has instalado Node.js en macOs. Para instalar Wiki.js en macOs tendrás que descargarlo primero usando wget:

wget https://github.com/Requarks/wiki/releases/latest/download/wiki-js.tar.gz

Luego extrae el paquete que has descargado a un directorio:

mkdir wiki
tar xzf wiki-js.tar.gz -C ./wiki
cd ./wiki

Luego renombra el archivo config.sample.yml con el nombre config.yml:

mv config.sample.yml config.yml

Seguidamente edita el archivo de configuración y configura los datos de acceso a la base de datos y el puerto. Por ejemplo:

port: 3000
db:
  type: mysql
  host: localhost
  port: 3306
  user: admin
  pass: tupass
  db: wikijs

Finalmente usa el siguiente comando para iniciar el servidor node:

node server

Instalación de Wiki.js en Windows

Antes de comenzar, asegúrate de que has instalado Node.js en Windows. Para instalar Wiki.js en Windows puedes usar Git Bash, por lo que instalarás Wiki.js del mismo modo que lo harías en Windows. Si prefieres usar comando de Windows, primero debes abrir una ventana de Powershell y descargarte Wiki.js mediante el siguiente comando:

Invoke-WebRequest -Uri "https://github.com/Requarks/wiki/releases/latest/download/wiki-js-windows.tar.gz" -OutFile "wiki-js.tar.gz"

Luego extrae el contenido del paquete descargado a un directorio:

New-Item -Path "C:\" -Name "wiki" -ItemType "directory"
tar xzf wiki-js.tar.gz -C "C:\wiki"
cd C:\wiki

Ahora renombra el archivo config.sample.yml, dándole el nombre de config.yml:

Rename-Item -Path config.sample.yml -NewName config.yml

Edita el archivo config.yml y configura la base de datos y el puerto con los datos de tu sistema:

port: 3000
db:
  type: mysql
  host: localhost
  port: 3306
  user: admin
  pass: tupass
  db: wikijs

Luego incia el servidor de node:

node server

Soporte Markdown

Wiki.js soporta una gran cantidad de elementos de la sintaxis de Markdown. En la siguiente guía puedes ver los elementos de la sintaxis básica de Markdown que soporta:

Soporte adicional de Wiki.js

Wiki.js también soporta los siguientes elementos de sintaxis avanzada de Markdown:

==texto resaltado==

<mark>texto resaltado</mark>

H~2~O

H<sub>2</sub>O

X^2^

X<sup>2</sup>

*[HTML]: Hyper Text Markup Language
La especificación HTML es mantenida
por la asociación W3C.

La especificación
<abbr title="Hyper Text Markup Language">HTML</abbr>
es mantenida por la asociación W3C.

Alternativas a Wiki.js

No encontrarás una mejor alternativa a Wiki.js con la que poder crear Wikis. Sin embargo, si buscas algo más sencillo y accesible, entonces puedes probar GitJournal. Si buscas algo que te permita organizar mejor los documentos, puedes probar Outline.

Otra aplicación que podría resultarte interesante es Notion, herramienta que no solo te permitirá crear wikis, sino también gestionar tareas y muchas otras cosas.

Más información

Si quieres saber más cosas acerca de Wiki.js, consulta los siguientes enlaces:

• Web: Accede a la web de Wiki.js
• Repositorio: Accede al repositorio de Wiki.js
• Documentación: Accede a la documentación de Wiki.js
• Documentación: Accede a la guía Markdown de Wiki.js