Documentation de Litho
Le voyage d'une page (Fonctionnement)
Litho est un moteur léger qui transforme vos notes brutes en pages web. Voici le chemin suivi par vos données :
- La Source : Vous rédigez un fichier .md (Markdown) avec un entête YAML.
- Les Parseurs : Litho utilise Parsedown pour le texte standard et ParsedownPlus pour les saveurs markdown et les fonctions avancées (galeries, EXIF, alertes).
- Le Template : Le résultat est injecté dans le fichier base.html de votre thème.
Anatomie du projet
Le site complet fonctionne avec moins de 5 Mo de code.
├── index.php <-- Le moteur
│
├── config
│ └── config.yml <-- la configuration
│
├── content <-- Vos pages sont là.
│ ├── index.md
│ ├── menu.md
│ ├── roadmap.md
│ └── truc.md
│
├── lib <-- Les bibliothèques (Parseurs)
│ ├── Parsedown.php
│ └── ParseDownPlus.php
│
└── themes <-- Vos dossiers de thèmes
└── monolith
├── base.html
├── header.html
├── logo.svg
└── style.css
Qu'est-ce qu'un fichier Markdown avec YAML ?
C'est un simple fichier texte qui commence par des métadonnées entre deux lignes ---.
---
title: Litho
author: Lahminewski
date: 01.01.2048
theme: lab
layout: base
robots: noindex,nofollow
---
# Titre 1
## Titre 2
### Titre 3
**Texte en gras**
*Texte en inatalique*
- liste
- liste
- liste
[Markdown Guide](https://www.markdownguide.org)

Guide de démarrage (Installation)
Pour installer Litho, nul besoin de terminal complexe ou de base de données. C'est un outil que l'on "pose" sur son hébergement.
- Téléchargement : Récupérez l'archive .zip de la dernière version.
- Transfert : Connectez-vous à votre serveur via FTP (ou SFTP, c'est mieux) et glissez tous les fichiers de l'archive à la racine de votre dossier web.
- Vérification : Rendez-vous sur votre adresse (https://votre-site.com). Si vous voyez la page d'accueil par défaut, Litho est prêt.
4. Fonctions avancées (Catalogue)
Litho en fait un peu plus que le Markdown standard pour aider les artistes et les chercheurs.
Galeries et Photos
- Galerie automatique : Créez un dossier dans
/content/img/ma-galerieet appelez-le avec[gallery:ma-galerie]. - EXIF : Pour les photographes, Litho peut extraire la date, l'ouverture et l'ISO de vos fichiers pour les afficher à côté de l'image.
Multimédia et Alertes
- Audio & Vidéo : Vous pouvez intégrer des lecteurs PeerTube ou Bandcamp simplement en copiant le code d'intégration (iframe) dans votre fichier Markdown.
- Alertes : Utilisez les "Callouts" pour mettre en avant une info importante.
- Fenced Divs : Pour les mises en page complexes (comme la notice Framalibre), vous pouvez encadrer votre texte de balises spécifiques.
5. Personnalisation
Litho est fait pour être modifié. Si vous savez un peu manipuler le CSS, vous pouvez tout changer.
Créer son thème
Le plus simple est de dupliquer le dossier themes/monolith, de le renommer (ex: themes/mon-theme) et de modifier le fichier style.css. Pour activer votre nouveau thème, changez le nom dans config/config.yml.
Variables CSS
La plupart de nos thèmes utilisent des variables au début du fichier CSS :
:root {
--couleur1 : #00ff41; /* La couleur principale */
--couleur2 : #bc13fe; /* La couleur d'accentuation */
}
En changeant juste ces deux codes couleurs, vous changez toute l'ambiance du site.
Fonctions avancées
Le flux RSS
- Lecture (News)
- Écriture (Suivi)
Site statique
Si vous utilisez GNU/Linux, il existe un programme en ligne de commande wget qui vous permet de passer votre site dynamique en site statique.
wget --convert-links -r -k -m -trust-server-names --adjust-extension https://Votesite.Sous.Litho/
Si vos entêtés YAML ne contiennent pas robots: noindex,nofollow tout devrait bien fonctionner.
Feuille de route
Beta V1.0.1
**Le coeur**
- Menu Markdown
- Page variable
- Lecture de répertoire
- page par défaut
- Robot not index
- Thème variable
- Flux RSS lecture
- Parsdown (1.7.4)
**Parsseur (Markdown Plus)**
- Galerie photos
- Exposent et indice
- Notes de bas de page
- Tâches
- balise mark
**Thème**
- Monolith
- Rhyolite
- linktree
Beta V1.0.5
**Le coeur**
- Parsdown (1.8.0)
**Parsseur (Markdown Plus)**
- Alertes
- Fenced Divs
- Photo avec EXIF
**Autre**
- Dossier des image par défaut /content
- Flux RSS type blog ...
Idée pour la suite
- Une vrais documentation
- multilingue
- Gestion des .csv pour les datas