Skip to content

Latest commit

 

History

History
222 lines (183 loc) · 8.25 KB

README.md

File metadata and controls

222 lines (183 loc) · 8.25 KB
Raw

mkdocs-include-markdown-plugin

Plugin d'inclusion de Markdown pour Mkdocs.

PyPI Tests Coverage status

Lire ce document dans d'autres langues:

Installation

pip install mkdocs-include-markdown-plugin

Documentation

Préparation

Activer le plugin dans votre fichier mkdocs.yml:

plugins:
  - include-markdown

Assurez-vous de définir include-markdown avant d'autres plugins qui pourraient entrer en conflit, comme mkdocs-macros-plugin.

Configuration

Le comportement global du plugin peut être personnalisé dans la configuration.

  • # opening_tag and closing_tag: Les balises d'ouverture et de fermeture par défaut. Par défaut sont {% et %}.

Le reste des options définira les valeurs par défaut passées aux arguments des directives et sont documentées dans la référence.

plugins:
  - include-markdown:
      opening_tag: "{!"
      closing_tag: "!}"
      encoding: ascii
      preserve_includer_indent: false
      dedent: true
      trailing_newlines: false
      comments: false

Référence

Ce plugin fournit deux directives, une pour inclure des fichiers Markdown et une autre pour inclure des fichiers de tout type.

Les paths des fichiers inclus peuvent être absolus ou relatifs au le path du fichier qui les inclut. Cet argument accepte également des globs, auquel cas certains paths peuvent être ignorés à l'aide de l'argument exclude.

Les chemins d'accès aux fichiers à inclure et les arguments de chaîne peuvent être entourés de guillemets doubles " ou simples ', qui peuvent être échappés en leur ajoutant un caractère \ comme \" et \'.

Les chaînes start et end peuvent contenir des séquences d'échappement habituelles (de style Python) telles que \n pour correspondre aux nouvelles lignes.

include-markdown

Inclut contenu des Markdown fichiers, en utilisant éventuellement deux délimiteurs pour filtrer le contenu à inclure.

  • # start: Délimiteur qui marque le début du contenu à inclure.
  • # end: Délimiteur qui marque la fin du contenu à inclure.
  • # preserve-includer-indent (true): Lorsque cette option est activée (par défaut), chaque ligne du contenu à inclure est indentée avec le même nombre d'espaces utilisé pour indenter l'incluseur modèle {% %}. Les valeurs possibles sont true et false.
  • # dedent (false): Lorsque est activée, le contenu inclus sera déchiqueté.
  • # exclude: Spécifiez avec un glob quels fichiers doivent être ignorés. Uniquement utile lors du passage de globs pour inclure plusieurs fichiers.
  • # trailing-newlines (true): Lorsque cette option est désactivée, les nouvelles lignes de fin trouvées dans le contenu à inclure sont supprimées. Les valeurs possibles sont true et false.
  • # encoding (utf-8): Spécifiez l'encodage du fichier inclus. S'il n'est pas défini, utf-8 sera utilisé.
  • # rewrite-relative-urls (true): Lorsque cette option est activée (par défaut), liens et images Markdown dans le contenu qui sont spécifiés par une URL relative sont réécrits pour fonctionner correctement dans leur nouvel emplacement. Les valeurs possibles sont true et false.
  • # comments (true): Lorsque cette option est activée (par défaut), le contenu à inclure est entouré de <!-- BEGIN INCLUDE --> et <!-- END INCLUDE --> commentaires qui aident à identifier que le contenu a été inclus. Les valeurs possibles sont true et false.
  • # heading-offset (0): Augmente ou diminue la profondeur des en-têtes Markdown de ce nombre. Ne prend en charge que la syntaxe d'en-tête du signe dièse (#). Cet argument accepte les valeurs négatives pour supprimer les caractères # de tête.
Exemples
{%
   include-markdown "../README.md"
   start="<!--intro-start-->"
   end="<!--intro-end-->"
%}
{%
   include-markdown 'docs/includes/header.md'
   start='<!--\n\ttable-start\n-->'
   end='<!--\n\ttable-end\n-->'
   rewrite-relative-urls=false
   comments=false
%}
{%
   include-markdown "docs/includes/header.md"
   heading-offset=1
%}
{%
   include-markdown "../LICENSE*"
   start="<!--license \"start\" -->"
   end='<!--license "end" -->'
   exclude="../LICENSE*.rst"
%}
{% include-markdown '/escap\'ed/single-quotes/in/file\'/name.md' %}

include

Inclus le contenu d'un fichier ou d'un groupe de fichiers.

  • # start: Délimiteur qui marque le début du contenu à inclure.
  • # end: Délimiteur qui marque la fin du contenu à inclure.
  • # preserve-includer-indent (true): Lorsque cette option est activée (par défaut), chaque ligne du contenu à inclure est indentée avec le même nombre d'espaces utilisé pour indenter l'incluseur modèle {% %}. Les valeurs possibles sont true et false.
  • # dedent (false): Lorsque est activée, le contenu inclus sera déchiqueté.
  • # exclude: Spécifiez avec un glob quels fichiers doivent être ignorés. Uniquement utile lors du passage de globs pour inclure plusieurs fichiers.
  • # trailing-newlines (true): Lorsque cette option est désactivée, les nouvelles lignes de fin trouvées dans le contenu à inclure sont supprimées. Les valeurs possibles sont true et false.
  • # encoding (utf-8): Spécifiez l'encodage du fichier inclus. S'il n'est pas défini, utf-8 sera utilisé.
Exemples
~~~yaml
{% include "../examples/github-minimal.yml" %}
~~~
    {%
      include "../examples.md"
      start="~~~yaml"
      end="~~~\n"
    %}
{%
   include '../LICENSE*'
   exclude='../LICENSE*.rst'
%}

Reconnaissance