Guía Markdown de HedgeDoc

Acerca de HedgeDoc

HedgeDoc está basado en el editor CodiMD. Se trata de un editor web que podrás instalar en tu servidor. A pesar de solo existir una versión web, HedgeDoc dispone de vistas para escritorio, tablet y móbil. Una vez instalado, podrás usar el editor de forma colaborativa con más usuarios.

Con HedgeDoc podrás crear notas, gráficos, diagramas y presentaciones en tiempo real, de forma que otros usuarios vean los cambios al instante. Para compartir notas, basta con que compartas un enlace con otros usuarios.

HedgeDoc incorpora un modo edición y también un modo de visualización en el que podrás ver las notas renderizadas. Además de su aspecto habitual, también dispone de un modo noche.

El sistema de login de HedgeDoc se integra con GitHub, Twitter, GitLab, LDAP, Authelia, NextCloud y Facebook, por lo que podrás iniciar sesión automáticamente si tienes una cuenta de estas aplicaciones. Continuando con las integraciones, dispone de una funcionalidad que te permitirá agregar imágenes y subirlas automáticamente a Amazon S3, Imgur o Minio, además del sistema en el que esté instalada la aplicación.

Además de Markdown, HedgeDoc también soporta metadatos en YAML, útil para configurar la visualización o Google Analytics. En cuanto a fórmulas y diagramas, HedgeDoc soporta las sintaxis LaTeX y MathJax y también diagramas de secuencia y de flujo UML. También soporta la sintaxis Graphviz e incluso la cración de partituras mediante la notación Abc.

Con HedgeDoc podrás llevar un seguimiento de los cambios de tus documentos, ya que incorpora un sistema de revisiones.

Instalación de HedgeDoc

HedgeDoc requiere que tengas instalado Node.js. Si no lo tienes instalado, consulta cómo instalar Node.js. También necesitarás ciertos conocimientos de la terminal de comandos y una base de datos MySQL, PostgreSQL, MariaDB o SQLite.

Si cumples los requisitos, descárgate la última versión o crea un nuevo directorio y clona el repostorio en un directorio con este comando:

git clone git@github.com:hedgedoc/hedgedoc.git ./

Para clonar el repositorio necesitas tener Git instalado en tu sistema. Si no lo tienes, consulta el tutorial de instalación de Git.

Luego accede al directorio donde has descargado HedgeDoc y ejecuta bin/setup para instalar HedgeDoc.

Mediante el archivo config.json podrás configurar la base de datos, el dominio y el puerto que usará HedgeDoc, entre otras cosas:

{
  "production": {
    "db": {
      "dialect": "sqlite",
      "storage": "./db.hedgedoc.sqlite"
   },
    "urlAddPort": true,
    "domain": "localhost"
  }
}

Para iniciar el servidor usa este comando, que además de iniciarlo también establecerá el entorno en modo producción:

NODE_ENV=production  yarn start

Para ejecutar el servidor en modo desarrollo usa este comando a secas:

yarn start

También puedes instalar HedgeDoc usando su imagen de Docker. Para más información consulta este enlace.

Soporte Markdown de HedgeDoc

HedgeDoc dispone de uno de los soportes más completos de Markdown que podrás encontrar. A continuación tienes una lista con los elementos soportados de la sintaxis básica de Markdown. Para ahorrarte la lectura te adelanto que soporta todos; incluso la maldita forma abreviada de los emojis. Sin embargo existe una excepción y es bastante importante, ya que no se soportan muchos elementos HTML:

Soporte adicional de HedgeDoc

HedgeDoc también soporta estos elementos de sintaxis avanzada de Markdown:

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.

Además también se soportan iconos de la fuente ForkAwesome mediante esta sintaxis:

<i class='fa'>

Alternativas a HedgeDoc

Una de las mejores alternativas es CodiMD, ya que es algo así como su pariente cercano, soportando las mismas funciones colaborativas.

Si buscas otros editores confunciones colaborativas también tienes Collected Notes o Notable.

Más información

Para más información acerca de HedgeDoc, consulta los siguientes enlaces:

• Web: Accede a la web de HedgeDoc
• Documentación: Accede la documentación HedgeDoc