Variables globales dans MkDocs

Question

J'ai un projet de documentation réalisé avec MkDocs. Je voudrais définir des variables globales dans le fichier de configuration (mkdocs.yml) à utiliser dans les pages de démarques (*.md).

La lecture de ce issue, il semble qu'il peut être fait en incluant une configuration extra dans le fichier mkdocs.yml, par exemple:

extra: 
    version: 1.0 

... puis, utilisez cette variable dans la page par exemple comme suit:

---> My version: {{ config.extra.version }} 

J'ai essayé, mais malheureusement, il ne fonctionne pas dans mon exemple (pas substution variable):

• Est-ce que je fais quelque chose de mal?
• Est-il possible de faire ce travail?

Answer 1

Non, ce n'est pas possible pour le moment.

Vous dites que vous "utilisez cette variable dans la page". Je suppose que vous voulez dire une page "Markdown". Pour l'instant, les variables de modèle ne sont pas disponibles dans les pages Markdown. Le moteur de template n'est même pas exécuté contre le Markdown. La sortie de l'analyseur Markdown est l'une des variables transmises au modèle. Pour une explication plus détaillée de la façon dont cela fonctionne, voir ma réponse à How do you include flask/jinja2 code inside a markdown file?. Il existe un problème ouvert (#304) concernant MkDocs, qui traite de l'ajout d'une fonctionnalité pour prendre en charge certains modèles limités dans les pages Markdown, mais il est planifié pour post-1.0, ce n'est donc pas une priorité absolue pour le moment.