You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Accept multiple files in inclusions using globs and add 'exclude' argument (#72)
* Accept multiple files in inclusions using globs and add 'exclude' argument
* Pin pre-commit job dependency
* Allow relative globs
* Improve included glob for files
* Bump version
Este plugin provee dos directivas, una para incluir archivos Markdown y otra para incluir archivos de cualquier tipo. Las rutas de los archivos incluidos pueden ser absolutas o relativas a la ruta del archivo que las incluye:
35
+
Este plugin provee dos directivas, una para incluir archivos Markdown y otra
36
+
para incluir archivos de cualquier tipo.
37
+
38
+
Las rutas de los archivos incluidos pueden ser absolutas o relativas a la ruta
39
+
del archivo que las incluye. Este argumento también acepta globs, en cuyo caso
40
+
ciertas rutas pueden ser ignoradas usando el argumento `exclude`:
33
41
34
42
#### **`include-markdown`**
35
43
36
-
Incluye contenido de archivo Markdown, opcionalmente usando dos delimitadores para filtrar el contenido a incluir.
44
+
Incluye contenido de archivos Markdown, opcionalmente usando dos delimitadores
45
+
para filtrar el contenido a incluir.
37
46
38
47
- **start**: Delimitador que marca el comienzo del contenido a incluir.
39
48
- **end**: Delimitador que marca el final del contenido a incluir.
40
-
- **preserve-includer-indent** (*true*): Cuando esta opción está habilitada (por defecto), cada línea del contenido a incluir es indentada con el mismo número de espacios usados para indentar la plantilla `{% %}` incluidora. Los valores posibles son `true` y `false`.
49
+
- **preserve-includer-indent** (*true*): Cuando esta opción está habilitada
50
+
(por defecto), cada línea del contenido a incluir es indentada con el mismo
51
+
número de espacios usados para indentar la plantilla `{% %}` incluidora. Los
52
+
valores posibles son `true` y `false`.
41
53
- **dedent** (*false*): Si se habilita, el contenido incluido será dedentado.
42
-
- **rewrite-relative-urls** (*true*): Cuando esta opción está habilitada (por defecto), los enlaces e imágenes Markdown en el contenido que están definidas mediante una URL relativa son rescritos para funcionar correctamente en su nueva localización. Los valores posibles son `true` y `false`.
43
-
- **comments** (*true*): Cuando esta opción está habilitada (por defecto), el contenido a incluir es envuelto por comentarios `<!-- BEGIN INCLUDE -->` y `<!-- END INCLUDE -->` que ayudan a identificar que el contenido ha sido incluido. Los valores posibles son `true` y `false`.
44
-
- **heading-offset** (0): Incrementa el tamaño de encabezados por este número. Sólo soporta sintaxis de encabezado de almohadilla (#). El valor máximo es 5.
45
-
46
-
> Nota que las cadenas **start** y **end** pueden contener caracteres usuales de secuencias de escape (al estilo Python) como `\n`, lo cual es útil si necesita hacer coincidir en un disparador de inicio o fin de varias líneas.
54
+
- **rewrite-relative-urls** (*true*): Cuando esta opción está habilitada (por
55
+
defecto), los enlaces e imágenes Markdown en el contenido que están definidas
56
+
mediante una URL relativa son rescritos para funcionar correctamente en su
57
+
nueva localización. Los valores posibles son `true` y `false`.
58
+
- **comments** (*true*): Cuando esta opción está habilitada (por defecto), el
59
+
contenido a incluir es envuelto por comentarios `<!-- BEGIN INCLUDE -->` y
60
+
`<!-- END INCLUDE -->`que ayudan a identificar que el contenido ha sido
61
+
incluido. Los valores posibles son `true` y `false`.
62
+
- **heading-offset** (0): Incrementa el tamaño de encabezados por este número.
63
+
Sólo soporta sintaxis de encabezado de almohadilla (#). El valor máximo es 5.
64
+
- **exclude**: Expecifica mediante un glob los archivos que deben ser
65
+
ignorados. Sólo es útil pasando globs para incluir múltiples archivos.
66
+
67
+
> Nota que las cadenas **start** y **end** pueden contener caracteres usuales
68
+
de secuencias de escape (al estilo Python) como `\n`, lo cual es útil si
69
+
necesita hacer coincidir en un disparador de inicio o fin de varias líneas.
47
70
48
71
##### Ejemplo
49
72
@@ -72,16 +95,32 @@ Incluye contenido de archivo Markdown, opcionalmente usando dos delimitadores pa
72
95
%}
73
96
```
74
97
98
+
```jinja
99
+
{%
100
+
include-markdown "../LICENSE*.md"
101
+
start="<!--license-start-->"
102
+
end="<!--license-end-->"
103
+
exclude="../LICENSE*.rst"
104
+
%}
105
+
```
106
+
75
107
#### **`include`**
76
108
77
-
Incluye el contenido de un archivo.
109
+
Incluye el contenido de un archivo o un grupo de archivos.
78
110
79
111
- **start**: Delimitador que marca el comienzo del contenido a incluir.
80
112
- **end**: Delimitador que marca el final del contenido a incluir.
81
-
- **preserve-includer-indent** (*true*): Cuando esta opción está habilitada (por defecto), cada línea del contenido a incluir es indentada con el mismo número de espacios usados para indentar la plantilla `{% %}` incluidora. Los valores posibles son `true` y `false`.
113
+
- **preserve-includer-indent** (*true*): Cuando esta opción está habilitada
114
+
(por defecto), cada línea del contenido a incluir es indentada con el mismo
115
+
número de espacios usados para indentar la plantilla `{% %}` incluidora. Los
116
+
valores posibles son `true` y `false`.
82
117
- **dedent** (*false*): Si se habilita, el contenido incluido será dedentado.
118
+
- **exclude**: Expecifica mediante un glob los archivos que deben ser
119
+
ignorados. Sólo es útil pasando globs para incluir múltiples archivos.
83
120
84
-
> Nota que las cadenas **start** y **end** pueden contener caracteres usuales de secuencias de escape (al estilo Python) como `\n`, lo cual es útil si necesita hacer coincidir en un disparador de inicio o fin de varias líneas.
121
+
> Nota que las cadenas **start** y **end** pueden contener caracteres usuales
122
+
de secuencias de escape (al estilo Python) como `\n`, lo cual es útil si
123
+
necesita hacer coincidir en un disparador de inicio o fin de varias líneas.
85
124
86
125
##### Ejemplo
87
126
@@ -99,9 +138,18 @@ Incluye el contenido de un archivo.
99
138
%}
100
139
```
101
140
141
+
```jinja
142
+
{%
143
+
include "../LICENSE*.md"
144
+
exclude="../LICENSE*.rst"
145
+
%}
146
+
```
147
+
102
148
## Agradecimientos
103
149
104
-
- Joe Rickerby y contribuidores por [darme los permisos][cibuildwheel-470] para separar este plugin de la documentación de [cibuildwheel][cibuildwheel-repo-link].
150
+
- Joe Rickerby y contribuidores por [darme los permisos][cibuildwheel-470] para
0 commit comments