2.5 KiB
2.5 KiB
Documentation Pena
Pena est une application de bureau de lecture de fichiers Markdown, construite avec
Tauri 2 (backend Rust) et du JavaScript vanilla (frontend, sans bundler).
Elle permet d'ouvrir un fichier .md isolé ou un dossier « wiki » complet, de naviguer entre
les documents, et de personnaliser entièrement le rendu via des thèmes et du CSS.
Le rendu Markdown → HTML est effectué côté Rust avec comrak
(CommonMark + extensions) et la coloration syntaxique via syntect.
Sommaire de la documentation
Documentation fonctionnelle
- Vue d'ensemble — à quoi sert Pena, pour qui, dans quels cas
- Fonctionnalités — liste détaillée de tout ce que l'application sait faire
- Interface — barre de titre, accueil, lecteur, barre latérale
- Thèmes et personnalisation — thèmes rapides et éditeur CSS
Documentation technique
- Architecture — Clean Architecture, découpage Rust et JS
- Commandes Tauri — référence des commandes exposées au frontend
Installation et build
- Installation (Linux générique / Fedora)
- Installation sur Bazzite OS — méthode simple : un fichier
.flatpakpré-construit, hébergé sur Gitea, installable en une commande - Build et compilation
- Release et distribution — portabilité d'un binaire Linux, formats de distribution, création d'un paquet Flatpak (avantages / inconvénients)
Outils annexes
- MarkdownRender (CLI Node.js) — convertisseur
md-renderen ligne de commande
Composants du dépôt
| Composant | Techno | Rôle |
|---|---|---|
Pena-tauri/ |
Tauri 2 + Rust + JS vanilla | Application de bureau principale (lecteur Markdown) |
MarkdownRender-nodejs/ |
Node.js | Outil CLI annexe md-render (conversion + preview live dans le navigateur) |
Le cœur du produit est
Pena-tauri.MarkdownRender-nodejsest un utilitaire indépendant, documenté dans outils/MarkdownRender-CLI.md.