MarginaliaMD

Présentation

MarginaliaMD est une application web qui permet de partager des documents Markdown et de collecter des annotations collaboratives. Elle peut aussi servir de portail de documentation publique, ou combiner les deux usages grâce à un mode hybride.

Concrètement, vous déposez vos documents Markdown, vous partagez un lien, et vos relecteurs annotent directement le texte depuis leur navigateur. Aucune inscription requise : chaque relecteur choisit un pseudonyme et commence à annoter.

Fonctionnalités principales

Annotations collaboratives -- Sélectionnez un passage de texte et ajoutez un commentaire. Les annotations sont surlignées dans le document avec une couleur par relecteur.
Trois modes de fonctionnement -- Mode revue (annotation), mode documentation (portail public) ou mode hybride (les deux combinés).
Portail de documentation -- Navigation arborescente, recherche plein texte, table des matières, fil d'Ariane et navigation précédent/suivant.
Éditeur WYSIWYG -- Éditeur Markdown intégré basé sur Milkdown pour modifier vos documents depuis l'interface d'administration.
Versionnage automatique -- Chaque modification crée une nouvelle version. Les annotations sont liées à la version du document.
Protection par mot de passe -- Protégez l'accès à des documents individuels avec un mot de passe.
8 langues -- Français, anglais, espagnol, allemand, italien, portugais, néerlandais et polonais.
Mode sombre -- Thème clair ou sombre selon vos préférences.
Aucune dépendance externe -- Tous les assets sont servis localement, pas de CDN requis.

Page d'accueil de MarginaliaMD en mode documentation avec les cartes de projets et la barre de recherche

Les trois modes

Mode Revue

Le mode par défaut. Vous gérez vos documents depuis l'interface d'administration et partagez des liens uniques avec vos relecteurs. Chaque document dispose d'un hash de 32 caractères qui sert d'identifiant public. Les annotations sont toujours activées.

Mode Documentation

Transforme MarginaliaMD en portail de documentation publique. Tous les documents sont accessibles via une navigation arborescente. La recherche plein texte (FTS5), la table des matières et la navigation précédent/suivant sont activées. Les annotations sont désactivées.

Mode Hybride

Combine le portail de documentation et les annotations. Les documents sont publiquement navigables, et vous pouvez activer les annotations sur certaines pages via le front matter YAML (annotations: true).

Prérequis

PHP 8.0 ou supérieur
Extensions PHP : pdo_sqlite (ou pdo_mysql), json, mbstring
Node.js 18+ (pour la compilation du frontend)
Apache 2.4+ avec mod_rewrite ou Nginx 1.18+

Licence

MarginaliaMD est distribué sous licence GNU AGPL v3+.

Support

Dépôt Git : inligit.fr/cap-rel/marginaliamd
Signaler un bug ou demander une fonctionnalité via les issues du dépôt