El plugin @docmd/plugin-git añade información del repositorio a su documentación. Consulta el historial local de Git durante la compilación para mostrar fechas de última actualización, autores y enlaces automatizados para editar las páginas.

Opciones de configuración

Configure los parámetros del repositorio en docmd.config.json:

Ejemplo de configuración

{
  "plugins": {
    "git": {
      "repo": "https://github.com/docmd-io/docmd",
      "branch": "main",
      "editLink": true,
      "lastUpdated": true,
      "commitHistory": true,
      "maxCommits": 5
    }
  }
}

Capacidades principales

• Marcas de tiempo de última actualización: Calculadas por archivo y mostradas en el pie de página.
• Historial de commits interactivo: Al pasar el cursor sobre la fecha, se muestran los hashes de commits recientes, mensajes y avatares de los autores.
• Enlaces automáticos de edición: Genera enlaces directos hacia GitHub, GitLab o Bitbucket.
• Caché en compilación: Las consultas de Git se ejecutan en tiempo de compilación y se guardan en caché local para no impactar en el rendimiento del navegador.

Controles a nivel de página

Desactive las funciones de Git en páginas específicas mediante el Frontmatter de página:

---
title: "Notas internas"
plugins:
  git: false
---

Integración en pipelines de CI/CD

El plugin de Git ejecuta comandos locales de la CLI git durante la compilación. Muchos servicios de CI/CD (como GitHub Actions o GitLab CI) realizan clonaciones superficiales (fetch-depth: 1), lo que trunca el historial y provoca que todas las páginas muestren la misma fecha de actualización.

Asegúrese de que su flujo de trabajo descargue el historial completo:

- name: Checkout del repositorio
  uses: actions/checkout@v4
  with:
    fetch-depth: 0

variables:
  GIT_DEPTH: 0

Soporte de localización

El plugin de Git admite traducción de cadenas de texto y formatos de fecha según el idioma activo mediante la configuración de localización de interfaz.