Aller au contenu principal
LisibleDocumentation
Previewer en direct

Référence

Référence complète

Retrouver tous les champs de frontmatter, flags, surfaces de configuration, commandes et routes générées.

Cette page rassemble le contrat public de Lisible. Les chapitres précédents expliquent les choix ; cette référence donne les valeurs attendues.

Frontmatter d’article

ChampTypeDéfautRôle
titlestring ≤ 70requistitre, SEO et listes
descriptionstring ≤ 160requisrésumé et métadonnées
pubDatedaterequistri et publication
updatedDatedateabsentdernière mise à jour
tagsstring[][]filtres et articles liés
draftbooleanfalseexclusion de production
coverchemin ou URLabsentcouverture
coverAltstringabsentalternative de couverture
featuredbooleanfalseépinglage accueil
seriesstringabsentidentifiant de série
seriesOrdernumberabsentordre dans la série
blueskyURI at://absentdiscussion par article

lisible.config.json

Toute la configuration utilisateur vit dans lisible.config.json à la racine du dépôt, validée par shared/config.ts et documentée par le schéma JSON de docs/lisible.config.schema.json. Chaque champ sauf variant est facultatif.

ChampTypeRôle
$schemastringchemin du schéma pour l’autocomplétion de l’éditeur
variantstring, requisvariante active parmi les six identifiants publics
site.titlestringnom du site dans les en-têtes, flux et métadonnées
site.urlstringURL canonique avec protocole
site.authorstringauteur crédité dans les métadonnées et le JSON-LD
site.accentstringcouleur d’accent par défaut, hexadécimale
site.postsPerPagenumbertaille de pagination des listes
site.featuredCountnumberarticles mis en avant sur l’accueil
site.coverPositionstringposition de cadrage des couvertures
social.*stringprofils github, bluesky, mastodon, linkedin, email
features.*booléens et objetsles flags listés ci-dessous
integrations.webmentions.domainstringdomaine webmention.io
integrations.comments.providerstringgiscus ou bluesky
integrations.comments.giscusobjetrepo, repoId, category, categoryId, mapping
integrations.comments.blueskyobjetpostUri par défaut
repo.url, repo.branchstringdépôt derrière les liens d’édition

Flags

Les flags vivent dans l’objet features de lisible.config.json. Une fonctionnalité désactivée ne laisse aucune trace dans le site construit.

FlagEffet principal
calloutsdirectives note/tip/warning/caution/important
mdxComponentsTabs, Steps et Spoiler
imageZoomvisionneuse plein écran
headingAnchorsancres copiables h2 à h4
relatedPostsrecommandations par similarité de tags
mathremark-math et KaTeX
mermaiddiagrammes interactifs avec zoom, déplacement et plein écran
drawiovisionneuse draw.io avec zoom, déplacement et plein écran
ogPerPostimage OG par article et locale
llmsTxtindex, corpus et Markdown exporté
aiButtonscopie Markdown et actions de lecture assistée par IA
socialShareintentions de partage
styledRssfeuille XSL des flux
webmentionsréactions webmention.io
commentsGiscus ou Bluesky
demoPlaceholdersaperçu local des commentaires, profils sociaux et webmentions
newPostCliscaffolder d’article
linkCheckcontrôle de liens
coversaffichage des couvertures
pinnedremontée des featured
paginationroutes paginées et pageSize
archivestimeline des publications
seriespages et navigation de série
commandPaletterecherche et actions Ctrl/Cmd+K
portfoliointerrupteurs enabled, certifications et friends des pages vitrine

Le composant partagé Tree s’importe directement depuis @shared/components/ui/file-tree et ne possède pas de flag dédié.

Routes françaises et anglaises

FrançaisEnglish
//en/
/about/en/about
/blog/en/blog
/blog/<page>/en/blog/<page>
/blog/<slug>/en/blog/<slug>
/blog/<slug>.md/en/blog/<slug>.md
/tags/en/tags
/tags/<tag>/en/tags/<tag>
/tags/<tag>/<page>/en/tags/<tag>/<page>
/archives/en/archives
/archives/<page>/en/archives/<page>
/series/en/series
/series/<slug>/en/series/<slug>
/rss.xml/en/rss.xml

Routes globales : /sitemap-index.xml, /robots.txt, /llms.txt, /llms-full.txt, /og/... et /pagefind/....

Routes de vitrine Organique

FrançaisEnglishPérimètre
/certifications/en/certificationsbadges fictifs et série partagée de trois articles de certification
/friends/en/friendsblogroll local de démonstration

Ces deux paires sont des démonstrations additives d’Organique, pas des routes communes du socle. Elles doivent rester bilingues et ne doivent pas être supposées disponibles après un changement de variante.

Commandes racine

init configuration guidée
dev serveur de la variante active
build build de la variante active
preview aperçu du build actif
variant affiche la variante
preview:all installe, build et sert les six variantes
new-post crée MDX par défaut, ou Markdown sur demande
check-links contrôle les liens du contenu
check-assets applique les budgets d’assets
check-variants validation complète des variantes nommées
check:all style, conformité, typecheck, build et sorties des sept variantes
typecheck astro check sur les sept variantes
test tests unitaires des helpers partagés
test:e2e suite Playwright sur les variantes construites
lint vérification lint et format Biome
format application du format Biome
check-style aucun tiret long, aucun emoji dans la documentation
check-drift compare le HTML construit à la base de référence
sync-og-assets régénère les assets Open Graph partagés
check-og-assets vérifie que les assets Open Graph sont synchronisés
check-og-output valide les images Open Graph générées

Références Astro

Documentation maintenue avec LisibleModifier cette page ↗

Actions

Recherchez une API, une commande ou un concept.