8
votes

Variables globales dans les MKDOCS

J'ai un projet de documentation effectué avec MKDOCS . Je voudrais définir des variables globales dans le fichier de configuration ( mkdocs.yml code>) à utiliser dans les pages de point ( *. MD code>).

lire ceci problème semble qu'il peut être fait en incluant une configuration extra code> dans Le fichier mkdocs.yml code>, par exemple: p> xxx pré>

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

---> My version: {{ config.extra.version }}
  • Est-ce que je fais quelque chose de mal? Li>
  • est possible de faire ce travail? LI> ul> p>


0 commentaires

3 Réponses :


3
votes

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". À ce moment-là, les variables de gabarit ne sont pas disponibles dans les pages Markdown. Le moteur de modèle n'est même pas exécuté contre le marquage. La sortie de l'analyseur de markdown est l'une des variables passées au gabarit. Pour une explication plus détaillée de la manière dont cela fonctionne, voir ma réponse à Comment inclure-tu le code du ballon / Jinja2 dans un fichier de marquage? .

spécifique à MKDOCS, il existe un problème ouvert ( # 304 ) Discuter de l'addition Une fonctionnalité permettant de prendre en charge une modélisation limitée dans les pages de marquage, mais elle est programmée pour Post-1.0, ce n'est donc pas une priorité absolue pour le moment.


0 commentaires

2
votes

En tant que mise à jour, il est possible d'insérer les variables à partir du logement extra dans mkocs.yml , exactement comme vous le décrivez.

Pour faire ce travail, vous devez installer le Plugin MarkdownexTradata .


0 commentaires

1
votes

La réponse donnée est obsolète, car cela peut être effectué avec des plugins tels que macros ou markdownextradata Comme mentionné ci-dessus, sauf que vous ne préférez que {{version}} .


0 commentaires