LHTML+ lhtml-site

Utiliser LHTML seul

LHTML est une commande et une bibliothèque Python à part entière : lhtml-site ne sert que pour construire des slides ou un site complet. Seul, LHTML convertit un fichier texte en page HTML, ou une chaîne en HTML dans votre propre outil Python.

Il vous faut : Python 3.10 ou plus récentDurée : 5 minVous obtenez : une page HTML à partir d'un fichier texte

1. Installer la commande lhtml

pipx install lhtml-markup
lhtml --version

Le paquet s'appelle lhtml-markup ; la commande et le module Python s'appellent lhtml. Dans un projet Python, installez-le plutôt dans son environnement virtuel : python -m pip install lhtml-markup. Pour pipx lui-même : voir Installer.

2. Une première page

Écrivez notes.l.html :

= Notes de cours

== Semaine 1

* **Lire** le chapitre sur l'__interpolation__
* Lancer `python demo.py`

puis convertissez-le :

lhtml notes.l.html --title "Notes de cours" -o notes.html

notes.html est une page complète : ouvrez-la dans votre navigateur. Sans --title, lhtml n'écrit que le HTML du contenu, à placer dans une page à vous.

  • Plusieurs fichiers d'un coup : lhtml pages/*.l.html --title Notes -o site/ écrit site/a.html, site/b.html...
  • Une erreur donne un avertissement avec sa position, et la page est quand même écrite : notes.l.html:12:1: warning: div:: is never closed (near 'div::').

3. Votre style et vos propres balises

Une feuille de style se donne avec --css ; une balise utilisée sur toutes les pages est une macro, déclarée une fois dans un fichier YAML donné avec -m :

# macros.yaml
note:
  class: note
lhtml -m macros.yaml notes.l.html --title "Notes de cours" --css style.css -o notes.html

note:: ... :: donne alors <div class="note"> ... </div>, mis en forme par .note dans style.css. Plus de détails dans Vos propres balises : les macros et, pour les couleurs des blocs de code, dans Code.

4. Depuis Python

import lhtml

macros = lhtml.load_macros('macros.yaml')
with open('notes.l.html', encoding='utf-8') as f:
    html = lhtml.run(f.read(), macros=macros)           # le HTML du contenu
page = lhtml.wrap(html, title='Notes de cours', css=['style.css'])   # une page complète

lhtml.run prend une chaîne et renvoie du HTML ; il ne lit ni n'écrit aucun fichier. Ses options (line_breaks, tags, lexers...) sont dans l'API Python (en anglais).

5. Avec un moteur de gabarits

LHTML laisse {{ ... }} et {% ... %} tels quels : un gabarit Jinja2 peut donc s'écrire en LHTML. Convertissez d'abord, puis rendez le gabarit.

import jinja2, lhtml

source = '''= {{ title }}
{% for week in weeks %}
== Semaine {{ loop.index }} : {{ week }}
{% endfor %}'''
template = jinja2.Template(lhtml.run(source))
print(template.render(title='Animation', weeks=['Splines', 'Images clés']))
# <h1>Animation</h1> <h2>Semaine 1 : Splines</h2> <h2>Semaine 2 : Images clés</h2>
Quand passer à lhtml-site

Pour des slides, un PDF de slides, ou un site de plusieurs pages avec un menu, lhtml-site fait le reste : gabarits, thèmes, menu, vidéos. Il inclut LHTML. Voir Premiers pas.

Suivant : Titres, la première page de la syntaxe, ou toutes les options dans la Référence de la syntaxe.

Construit avec lhtml-site, thème docs. Fait partie de ScholarTools.