MiaoYan : une application Markdown locale pour macOS
tw93/MiaoYan offre une implémentation open source exploitable en conditions réelles avec une structure réutilisable.
En bref
- De quoi s’agit-il ?
- Une application de prise de notes Markdown pour macOS écrite en Swift, qui stocke les notes dans un dossier de votre choix et propose un aperçu divisé, une CLI et une synchronisation cloud optionnelle.
- À qui s’adresse-t-il ?
- MiaoYan est un éditeur Markdown local pour macOS qui laisse la synchronisation cloud au fournisseur de dossiers, propose une CLI pour les opérations de notes et inclut un aperçu divisé. Le README distingue clairement ce que l'application fait et ce qu'elle évite délibérément.
- Puis-je l’utiliser commercialement ?
- Oui. MIT est une licence permissive : vous pouvez utiliser, modifier et vendre un logiciel qui en dépend, à condition de conserver les mentions de droit d’auteur et de licence.
- Est-il encore maintenu ?
- Oui. Les derniers commits datent d’il y a 9 jours.
- En quel langage est-il écrit ?
- Principalement Swift, d’après les statistiques de langage de GitHub.
Ces réponses reposent sur les données GitHub du projet (dernière synchronisation le 14 septembre 2026) et sur notre analyse. Elles ne constituent pas un avis juridique.
ANALYSE OPEN SOURCE APPROFONDIE
Notes Markdown locales sur macOS
MiaoYan est une application légère de prise de notes Markdown pour macOS, écrite en Swift. Le README la qualifie de locale et affirme qu'elle ne collecte aucune donnée. Les fonctionnalités listées incluent un éditeur et un aperçu divisés, des liens retour wikilink, la prise en charge de LaTeX et Mermaid, une mise en page minimale à trois colonnes, le mode sombre, le verre macOS 26, le mode sans distraction, l'historique des versions, les raccourcis clavier et le formatage automatique. Les métadonnées du dépôt indiquent Swift comme langage, macOS 11.5 ou ultérieur comme exigence système, et environ 8 500 étoiles et 500 forks.
Trois méthodes d'installation documentées
Le README documente trois méthodes d'installation. La version Mac App Store est payante et reçoit des mises à jour automatiques. Les utilisateurs de Homebrew peuvent exécuter `brew install --cask miaoyan`. GitHub Releases propose un DMG pour macOS 11.5 ou ultérieur. Le README déclare que les trois options partagent la même base de code et reçoivent les mêmes mises à jour. Après l'installation, l'application attend un dossier `MiaoYan` dans iCloud Drive, un dossier de cloud de bureau ou un autre emplacement préféré, et le chemin de stockage est défini dans les préférences avec Commande-virgule (⌘,).
Stockage basé sur les dossiers et synchronisation cloud
MiaoYan ne se connecte pas à des comptes WebDAV ou de cloud. Il lit et écrit le dossier Markdown choisi par l'utilisateur, et un client de cloud séparé comme iCloud Drive, Nutstore ou Dropbox est responsable de la synchronisation de ce dossier entre les appareils. Sur Mac, la configuration recommandée consiste à créer un dossier `MiaoYan` dans le dossier local synchronisé par le client de bureau Nutstore, puis à pointer l'emplacement de stockage de MiaoYan vers ce dossier dans les préférences. Sur iPhone, le même dossier est sélectionné dans l'app Fichiers du système ; si un fournisseur n'expose pas de dossier inscriptible, le README suggère d'utiliser iCloud Drive ou de rendre le dossier disponible hors ligne dans l'application du fournisseur avant de le choisir. L'application vérifie l'accès en lecture et en écriture avant de changer de dossier et conserve le chemin actuel si le nouveau n'est pas disponible.
Une interface en ligne de commande pour les opérations rapides
Le README documente une interface en ligne de commande installée avec `curl -fsSL https://raw.githubusercontent.com/tw93/MiaoYan/main/scripts/install.sh | bash`. La commande `miao` prend en charge six opérations : `open` pour ouvrir une note ou un dossier, `new` pour créer une note, `search` pour rechercher des notes, `list` pour lister les dossiers ou les notes, `cat` pour afficher le contenu d'une note et `update` pour mettre à jour la CLI elle-même. Le README ne précise pas quel gestionnaire de paquets ou quel environnement shell est requis au-delà du script d'installation.
Mode éditeur et aperçu divisés
Le mode éditeur et aperçu divisés place l'édition et l'aperçu côte à côte avec un aperçu en temps réel et, selon le README, une synchronisation de défilement bidirectionnelle à 60 fps. Il peut être activé avec `⌘\` ou via Préférences → Interface → Mode d'édition → Mode divisé. Le README explique qu'un éditeur WYSIWYG comme Typora n'est pas l'objectif ; l'édition Markdown pure est privilégiée, et implémenter WYSIWYG en Swift natif ajouterait de la complexité et des préoccupations de fiabilité. Le mode divisé offre une surface d'édition propre tout en donnant un retour visuel immédiat.
Documentation, mode PPT et compétence d'agent
Trois ressources de documentation sont listées. Le guide de syntaxe Markdown couvre la référence de syntaxe avec des fonctionnalités avancées. Le guide du mode présentation PPT explique comment créer des présentations en utilisant `---` comme séparateurs de diapositives. Il existe également une compétence d'agent MiaoYan qui enseigne à un agent la syntaxe MiaoYan, les pièces jointes, les modèles PPT et les flux de travail CLI ; elle peut être installée avec `npx skills add tw93/MiaoYan/skills/miaoyan -g`. Le README ne décrit pas le format de sortie PPT ni comment la compétence d'agent est invoquée au-delà de la commande d'installation.
Licence MIT et remerciements du projet
Le projet est publié sous la licence MIT, copyright 2022 Tw93. La licence accorde la permission d'utiliser, copier, modifier, fusionner, publier, distribuer, sous-licencier et vendre des copies du logiciel, à condition d'inclure l'avis de droit d'auteur et l'avis de permission ci-dessus. Elle indique également que le logiciel est fourni « tel quel », sans garantie d'aucune sorte, et que les auteurs ne sont pas responsables des dommages. Le texte de la licence ne dit rien sur le support, la sécurité ou la maintenance. Les remerciements du README listent plusieurs dépendances et références, notamment fsnotes, swift-cmark-gfm, Prettier, Highlightr, la police TsangerJinKai et reveal.js.
Conclusion éditoriale
MiaoYan est un éditeur Markdown local pour macOS qui laisse la synchronisation cloud au fournisseur de dossiers, propose une CLI pour les opérations de notes et inclut un aperçu divisé. Le README distingue clairement ce que l'application fait et ce qu'elle évite délibérément. Les métadonnées du dépôt montrent un problème ouvert et que le projet n'est pas archivé.
Notes de la communauté