Guía Markdown de Outline

Outline es una herramienta que permite crear bases de conocimiento de forma colaborativa.

Outline es una aplicación que permite a los equipos crear bases de conocimiento, documentaciones y notas, entre otra cosas, de forma colaborativa.

Acerca de Outline

Outline está disponible en dos modalidades. Una de ellas es un servicio de suscripción al que te podrás suscribir en la web de Outline. Sin embargo, Outline es también una aplicación open source que podrás encontrar en su repositorio de GitHub.

Imagen de Outline

Outline se centra en la creación de wikis, aunque también podrás crear notas, ebooks y cualquier otro tipo de documento Markdown. El editor de Outline es un editor híbrido con el que podrás redactar los textos mediante la sintaxis Markdown. Sin embargo, el texto se formateará en pantalla a medida que escribes.

Cuando guardes los documentos, se almacenarán en formato Markdown, pudiendo también exportar los documentos en este mismo formato, de modo que los puedas editar con cualquier otra aplicación. También podrás exportar los documentos en formato PDF.

Outline es una aplicación colaborativa, por lo que podrás establecer permisos de lectura y escritura para para los documentos. También podrás compartir cualquier documento mediante un enlace público. Con respecto a la gestión de usuarios, también podrás organizar a los miembros del equipo en grupo.

Outline se integra con muchas otras aplicaciones, como por ejemplo Slack, Airtable, Google Docs o Trello. Puedes consultar la lista completa de integraciones en este enlace.

Además de la sitnaxis Markdown habitual, también podrás usar comandos "slash", que siguen el formato /comando.

Requisitos de Outline

Podrás instalar Outline en tu propio servidor o en tu sistema local. Sin embargo, necesitas tener ciertas aplicaciones instaladas:

Además, para el almacenamiento de los archivos, también tendrás que tener un bucket de AWS S3 o algún otro servicio que disponga de una API compatible. Finalmente, para crear las cuentas de usuario, necesitarás una cuenta de desarrollador de Slack o de Google.

Instalación de Outline

Para instalar la aplicación, inicia la terminal de comandos de tu sistema y accede al directorio de Outline. Luego sigue estos pasos:

  1. Clona el repositorio de GitHub de Outline.
  2. Instala las dependencias de la aplicación con el comando yarn build.
  3. Luego renombra el archivo .env.sample como .env y establece los valores de las siguientes opciones:
    • SECRET_KEY: Usa el comando openssl rand -hex 32 para generar la clave.
    • SLACK_KEY: Se trata de la clave Client ID de Slack.
    • SLACK_SECRET: Es la clave Client Secret de Slack.
    • DATABASE_URL: Establece la URL local de PostgreSQL o del servicio cloud que uses.
    • REDIS_URL: Establece la URL local de Redis o del servicio cloud que uses.
    • URL: La URL pública que tendrá la aplicación.
    • AWS_: La clave del bucket de AWS.
  4. Si vas a usar un certificado SSL, migra la base de datos ejecutando el comando yarn sequelize:migrate, de lo contrario usa el comando yarn sequelize:migrate --env=production-ssl-disabled.
  5. Luego inicia la aplicación con el comando NODE_ENV=production pm2 start ./build/server/index.js --name outline, en caso de que uses el gestor de procesos pm2. De lo contrario usa el comando node ./build/server/index.js.

Con esto ya estará la aplicación instalada e iniciada en tu sistema. Puedes acceder a ella en la URL http://localhost:3000, aunque el puerto podría ser diferente al puerto 3000. De instalar la aplicación en un servidor, reemplaza localhost por el nombre de dominio.

Si vas a modificar el código de la aplicación, puedes crear un servidor de desarrollo usando Docker.

Si lo que te interesa es el editor de Outline, creado con React, podrás integrarlo con cualquier proyecto. Puedes instalarlo mediante uno de los siguientes comandos:

# npm
npm install rich-markdown-editor

# Yarn
yarn add rich-markdown-editor

Soporte Markdown

Outline soporta los elementos de la sintaxis básica de Markdown y algunos de los elementos de la sitnaxis avanzada. En la siguietne tabla podrás ver los elementos compatibles:

ElementoSoporteNotas
EncabezadosSí
PárrafosSí
Saltos de líneaSíTambién podrás saltar de línea pulsando INTRO.
NegritaSí
CursivaSí
CitasSí
Listas ordenadasSí
Listas no ordenadasSí
CódigoSí
Línea horizontalSí
EnlacesSí
ImágenesParcialNo podrás agregarlas mediante la sintaxis Markdown, pero sí mediante el comando /table.
HTMLNo
TablasSí
Bloques de código avanzadosSí
Resaltado de sintaxisSí
Notas al piéNo
IDs de cabeceraParcialNo podrás personalizarlos, pero se crearán automáticamente.
Listas de definicionesNo
Texto tachadoSí
Listas de tareasSíPodrás usar corchetes [ ], pero no guiones.
Emojis (copiar y pegar)Sí
Emojis (shortcodes)No
Enlaces automáticosNo
Deshabilitar enlaces automáticosNo

Alternativas a Outline

También existen otras aplicaciones que permiten crear bases de conocimiento usando Markdown. Una ejemplo de ello es la aplicación Airsend, que es más fácil de instalar y está disponible para cualquier sistema operativo. Otra aplicación colaborativa que también permite crear wikis es Notion.

Otras aplicaciones que permiten editar documentos en tiempo real de forma colaborativa son CodiMD y HackMD. Si trabajas en un equipo de desarrollo de software también puedes probar Boostnote.

Más información

Puedes obtener más información acerca de Outline consultando los enlaces que ves a continuación: