====== HedgeDoc ======

HedgeDoc (antes llamado **CodiMD**) es un editor colaborativo de [[..:..:markdown|Markdown]] que permite trabajar con otras personas en tiempo real, visualizar resultados instantáneos y editar notas, diagramas o presentaciones de forma compartida. 

  * [[https://hedgedoc.org/|Sitio web]]
  * [[https://github.com/hedgedoc/hedgedoc|Repositorio de código]]

{{ https://hedgedoc.org/images/screenshot.png |}}

===== Características =====

  * **Colaboración en tiempo real**: Varios usuarios pueden editar el mismo documento simultáneamente y ver los cambios al instante. 
  * **Autohospedado**: Puedes instalar HedgeDoc en tu propio servidor, de modo que los datos quedan bajo tu control. 
  * **Modo presentación** (//slides//): Permite convertir notas en presentaciones tipo diapositivas desde el propio Markdown (usando Reveal.js) 
  * **Gráficos, diagramas y contenido embebido**: Soporta sintaxis para gráficos (mermaid, flowcharts, Graphviz, etc.), diagramas UML, fórmulas matemáticas (LaTeX / MathJax) y otros contenidos embebidos. 
  * **Gestión de permisos / acceso**: Puedes definir qué usuarios pueden ver o editar las notas (por ejemplo: invitados, solo lectura, edición limitada, privado). 
  * **Historial de revisiones / versiones**: Se guarda un historial de cambios, de modo que puedes revertir a versiones anteriores si es necesario. 
  * **Bajo requerimiento de recursos**: No es muy exigente en cuanto a hardware; incluso puede funcionar en sistemas modestos como una Raspberry Pi. 
  * **Interfaz web**: No necesitas instalar software adicional: funciona en navegador, y tiene vistas adaptadas para escritorio, tabletas y móviles. 
  * **Soporte para metadatos YAML**: Permite añadir metadatos al documento (como título, descripción, etiquetas, configuración de slide, etc.) mediante YAML al inicio del documento. 
  * **Exportación / importación de documentos**: Se pueden exportar notas como Markdown, HTML, etc., e importar contenido desde archivos Markdown o desde el portapapeles / HTML. 
  * **Integraciones**: Se puede integrar con sistemas de autenticación externos (OAuth, LDAP, GitLab, etc.), configurar almacenamiento de imágenes en servicios como S3, Imgur o almacenamiento local, entre otras cosas. 
  * **Código abierto** / licencia AGPL

===== Instalación =====

==== Docker ====

Utilizando la imagen de [[https://www.linuxserver.io/|LinuxServer]]:

<code yaml>
---
services:
  hedgedoc:
    image: lscr.io/linuxserver/hedgedoc:latest
    container_name: hedgedoc
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - "DB_HOST=<hostname or ip>"
      - DB_PORT=3306
      - DB_USER=hedgedoc
      - "DB_PASS=<secret password>"
      - DB_NAME=hedgedoc
      - CMD_DOMAIN=localhost
      - CMD_URL_ADDPORT=false #optional
      - CMD_PROTOCOL_USESSL=false #optional
      - CMD_PORT=3000 #optional
      - CMD_ALLOW_ORIGIN=['localhost'] #optional
      - CMD_DB_DIALECT= #optional
    volumes:
      - /path/to/hedgedoc/config:/config
    ports:
      - 3000:3000
    restart: unless-stopped
</code>

===== Configuración =====

==== URLs personalizadas ====

Si queremos crear notas indicando la URL, como por ejemplo, https://pad.example.org/mi-nota-alucinante, tendremos que activar la siguiente variable de entorno:

<code bash>
CMD_ALLOW_FREEURL=true
</code>

  * [[https://docs.hedgedoc.org/references/url-scheme/|URL Scheme]]
===== Uso =====

==== Markdown ====

Hedgedoc sigue el estándar CommonMark de Markdown, pero también soporta algunas extensiones del [[https://github.github.com/gfm/|GitHub Flavored Markdown]]

En [[https://docs.hedgedoc.org/references/hfm/|esta página]] está la lista con todo lo que soporta su versión propia de Markdown.

En la instancia de demostración podemos ver una página con [[https://demo.hedgedoc.org/features|una muestra de todo lo que soporta]].

==== Metadatos ====

En todas las notas que creemos es posible añadir información extra sobre la misma. Para ello, al comienzo de la nota escribiremos algo como:

<code yaml>
---
title: Hola, mundo
lang: es
tags: pruebas, hedgedoc
robots: noindex, nofollow
---
</code>

  * [[https://docs.hedgedoc.org/references/yaml-metadata/|YAML Metadata]]

==== Eliminar notas de anónimos ====

Comentario en [[https://community.hedgedoc.org/t/delete-freely-note/1139/2|Delete freely note]]:

  Hi @JPT77!

  Deleting a note as an admin is currently only possible via direct operation on the database. The easiest way to find the note in the database is by the “short id”. This can be found in the URL when opening the “publish” view.

  Example: There’s a note at https://demo.hedgedoc.org/wNvA2KmtRHixDAn34984JQ that should be deleted. The “Publish” view (button in the top bar) links to https://demo.hedgedoc.org/s/yp1QGycyo. Therefore yp1QGycyo is the short id.

  Now we can delete this note from the database using SQL:

  DELETE FROM "Notes" WHERE shortid = 'yp1QGycyo';

  Kind regards,
  Erik