Enlace a repositorio¶

Podemos mostrar en la cabecera de nuestra documentación un enlace al repositorio GitHub, incluyendo información sobre estrellas y forks, fecha de actualización, y contribuidores.

Repositorio¶

Para mostrar el enlace al repositorio, en mkdocs.yml añadimos la URL. Por ejemplo:

repo_url: https://github.com/squidfunk/mkdocs-material

En repositorio como GitHub or GitLab, se mostrará el número de versión, estrellas y forks de forma automática.

Nombre del repositorio¶

El nombre que aparece en el enlace es deducido automáticamente en el caso de GitHub, GitLab o Bitbucket. Podemos configurarlo manualmente con:

repo_name: squidfunk/mkdocs-material

Icono¶

Podemos sustituir el icono por defecto por otro:

theme:
  icon:
    repo: fontawesome/brands/git-alt

Algunas posibilidades:

fontawesome/brands/git
fontawesome/brands/git-alt
fontawesome/brands/github
fontawesome/brands/github-alt
fontawesome/brands/gitlab
fontawesome/brands/gitkraken
fontawesome/brands/bitbucket
fontawesome/solid/trash

Acceso al texto fuente¶

Si repo_url apunta a un repositorio válido en casos como GitHub, GitLab o Bitbucket, MkDocs proporciona un parámetro edit_uri que permite apuntar a una subcarpeta donde se aloja la documentación. Si la rama es main:

edit_uri: edit/main/docs/

Una vez hecho esto, podemos añadir botones para visualizar y editar el texto original (GitHub):

theme:
  features:
    - content.action.edit
    - content.action.view

Los iconos pueden modificarse con:

theme:
  icon:
    edit: material/pencil 
    view: material/eye

Versiones¶

Para mostrar la fecha de creación, última actualización del documento, y lista de autores y contribuidores, tenemos que instalar un complemento python en el terminal de comandos:

pip install mkdocs-git-revision-date-localized-plugin

Seguidamente, añadir a mkdocs.yml:

plugins:
  - git-revision-date-localized:
      enable_creation_date: true

Esto muestra la fecha de creación del documento. El formato puede ser date, datetime, iso_date, iso_datetime o timeago:

plugins:
  - git-revision-date-localized:
      type: date