Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: mondeja/mkdocs-include-markdown-plugin
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v6.1.1
Choose a base ref
...
head repository: mondeja/mkdocs-include-markdown-plugin
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: v6.2.0
Choose a head ref
  • 5 commits
  • 17 files changed
  • 1 contributor

Commits on Jun 1, 2024

  1. Add recursive setting to JSONSchema

    mondeja committed Jun 1, 2024
    Copy the full SHA
    6889f54 View commit details

Commits on Jun 2, 2024

  1. Warn when passing invalid arguments to directives (#214)

    mondeja authored Jun 2, 2024

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    Copy the full SHA
    42981e4 View commit details

Commits on Jun 5, 2024

  1. Don't import typing.Any on runtime (#216)

    mondeja authored Jun 5, 2024

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    Copy the full SHA
    1dd2835 View commit details

Commits on Jun 10, 2024

  1. Apply substitutions from all directives at once (#217)

    mondeja authored Jun 10, 2024

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    Copy the full SHA
    f7ebed6 View commit details
  2. Add recursive argument to include-markdown directive (#218)

    mondeja authored Jun 10, 2024

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    Copy the full SHA
    7a7cb71 View commit details
59 changes: 33 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -155,6 +155,9 @@ content to include.
- <a name="include-markdown_trailing-newlines" href="#include-markdown_trailing-newlines">#</a>
**trailing-newlines** (_true_): When this option is disabled, the trailing newlines
found in the content to include are stripped. Possible values are `true` and `false`.
- <a name="include-markdown_recursive" href="#include-markdown_recursive">#</a>
**recursive** (_true_): When this option is disabled, included files are not
processed for recursive includes. Possible values are `true` and `false`.
- <a name="include-markdown_encoding" href="#include-markdown_encoding">#</a>
**encoding** (_utf-8_): Specify the encoding of the included file.
If not defined `utf-8` will be used.
@@ -177,42 +180,42 @@ content to include.

```jinja
{%
include-markdown "../README.md"
start="<!--intro-start-->"
end="<!--intro-end-->"
include-markdown "../README.md"
start="<!--intro-start-->"
end="<!--intro-end-->"
%}
```

```jinja
{%
include-markdown 'includes/header.md'
start='<!--\n\ttable-start\n-->'
end='<!--\n\ttable-end\n-->'
rewrite-relative-urls=false
comments=false
include-markdown 'includes/header.md'
start='<!--\n\ttable-start\n-->'
end='<!--\n\ttable-end\n-->'
rewrite-relative-urls=false
comments=false
%}
```

```jinja
{%
include-markdown "includes/header.md"
heading-offset=1
include-markdown "includes/header.md"
heading-offset=1
%}
```

```jinja
{%
include-markdown "../LICENSE*"
start="<!--license \"start\" -->"
end='<!--license "end" -->'
exclude="../*.rst"
include-markdown "../LICENSE*"
start="<!--license \"start\" -->"
end='<!--license "end" -->'
exclude="../*.rst"
%}
```

```jinja
{%
include-markdown "**"
exclude="./{index,LICENSE}.md"
include-markdown "**"
exclude="./{index,LICENSE}.md"
%}
```

@@ -243,12 +246,12 @@ Includes the content of a file or a group of files.
- <a name="include_trailing-newlines" href="#include_trailing-newlines">#</a>
**trailing-newlines** (_true_): When this option is disabled, the trailing newlines
found in the content to include are stripped. Possible values are `true` and `false`.
- <a name="include_recursive" href="#include_recursive">#</a>
**recursive** (_true_): When this option is disabled, included files are not
processed for recursive includes. Possible values are `true` and `false`.
- <a name="include_encoding" href="#include_encoding">#</a>
**encoding** (_utf-8_): Specify the encoding of the included file.
If not defined `utf-8` will be used.
- <a name="recursive" href="#include_recursive">#</a>
**recursive** (_true_): When this option is disabled, included files are not
processed for recursive includes. Possible values are `true` and `false`.

##### Examples

@@ -260,23 +263,24 @@ Includes the content of a file or a group of files.

```jinja
{%
include "../examples.md"
start="~~~yaml"
end="~~~\n"
include "../examples.md"
start="~~~yaml"
end="~~~\n"
%}
```

```jinja
{%
include '**'
exclude='./*.md'
include '**'
exclude='./*.md'
%}
```

## Acknowledgment

- Joe Rickerby and contributors for
[giving me the permissions][cibuildwheel-470] to separate this plugin from the
- [Joe Rickerby] and [contributors] for
[giving me the permissions][cibuildwheel-470] to
[separate this plugin][cibuildwheel-475] from the
documentation of [cibuildwheel][cibuildwheel-repo-link].

[Bash wildcard globs]: https://facelessuser.github.io/wcmatch/glob/#syntax
@@ -293,7 +297,10 @@ Includes the content of a file or a group of files.
[license-link]: https://github.com/mondeja/mkdocs-include-markdown-plugin/blob/master/LICENSE
[platformdirs]: https://pypi.org/project/platformdirs/
[cibuildwheel-470]: https://github.com/pypa/cibuildwheel/issues/470
[cibuildwheel-475]: https://github.com/pypa/cibuildwheel/pull/475
[cibuildwheel-repo-link]: https://github.com/pypa/cibuildwheel
[es-readme-link]: https://github.com/mondeja/mkdocs-include-markdown-plugin/blob/master/locale/es/README.md
[fr-readme-link]: https://github.com/mondeja/mkdocs-include-markdown-plugin/blob/master/locale/fr/README.md
[`docs_dir`]: https://www.mkdocs.org/user-guide/configuration/#docs_dir
[Joe Rickerby]: https://github.com/joerick
[contributors]: https://github.com/mondeja/mkdocs-include-markdown-plugin/graphs/contributors
61 changes: 34 additions & 27 deletions locale/es/README.md
Original file line number Diff line number Diff line change
@@ -144,6 +144,10 @@ href="#include-markdown_trailing-newlines">#</a> **trailing-newlines**
(*true*): Cuando esta opción está deshabilitada, los saltos de línea finales que
se encuentran en el contenido a incluir se eliminan. Los valores posibles son
`true` y `false`.
- <a name="include-markdown_recursive" href="#include-markdown_recursive">#</a>
**recursive** (*true*): Cuando esta opción está deshabilitada, los archivos
incluidos no son procesados para incluir de forma recursiva. Los valores
posibles son `true` y `false`.
- <a name="include-markdown_encoding" href="#include-markdown_encoding">#</a>
**encoding** (*utf-8*): Especifica la codificación del archivo incluído. Si no
se define, se usará `utf-8`.
@@ -168,42 +172,42 @@ especificado. Sólo soporta la sintaxis de encabezado de caracteres de hash

```jinja
{%
include-markdown "../README.md"
start="<!--intro-start-->"
end="<!--intro-end-->"
include-markdown "../README.md"
start="<!--intro-start-->"
end="<!--intro-end-->"
%}
```

```jinja
{%
include-markdown 'includes/header.md'
start='<!--\n\ttable-start\n-->'
end='<!--\n\ttable-end\n-->'
rewrite-relative-urls=false
comments=false
include-markdown 'includes/header.md'
start='<!--\n\ttable-start\n-->'
end='<!--\n\ttable-end\n-->'
rewrite-relative-urls=false
comments=false
%}
```

```jinja
{%
include-markdown "includes/header.md"
heading-offset=1
include-markdown "includes/header.md"
heading-offset=1
%}
```

```jinja
{%
include-markdown "../LICENSE*"
start="<!--license \"start\" -->"
end='<!--license "end" -->'
exclude="../*.rst"
include-markdown "../LICENSE*"
start="<!--license \"start\" -->"
end='<!--license "end" -->'
exclude="../*.rst"
%}
```

```jinja
{%
include-markdown "**"
exclude="./{index,LICENSE}.md"
include-markdown "**"
exclude="./{index,LICENSE}.md"
%}
```

@@ -234,13 +238,13 @@ globs para incluir múltiples archivos.
**trailing-newlines** (*true*): Cuando esta opción está deshabilitada, los
saltos de línea finales que se encuentran en el contenido a incluir se eliminan.
Los valores posibles son `true` y `false`.
- <a name="include_recursive" href="#include_recursive">#</a> **recursive**
(*true*): Cuando esta opción está deshabilitada, los archivos incluidos no son
procesados para incluir de forma recursiva. Los valores posibles son `true` y
`false`.
- <a name="include_encoding" href="#include_encoding">#</a> **encoding**
(*utf-8*): Especifica la codificación del archivo incluído. Si no se define,
se usará `utf-8`.
- <a name="recursive" href="#include_recursive">#</a> **recursive** (*true*):
Cuando esta opción está deshabilitada, los archivos incluidos no son
procesados para incluir de forma recursiva. Los valores posibles son `true` y
`false`.

##### Ejemplos

@@ -252,23 +256,23 @@ procesados para incluir de forma recursiva. Los valores posibles son `true` y

```jinja
{%
include "../examples.md"
start="~~~yaml"
end="~~~\n"
include "../examples.md"
start="~~~yaml"
end="~~~\n"
%}
```

```jinja
{%
include '**'
exclude='./*.md'
include '**'
exclude='./*.md'
%}
```

## Agradecimiento

- Joe Rickerby y contribuidores por [darme los permisos][cibuildwheel-470] para
separar este plugin de la documentación de
- [Joe Rickerby] y [contribuidores] por [darme los permisos][cibuildwheel-470]
para [separar este plugin][cibuildwheel-475] de la documentación de
[cibuildwheel][cibuildwheel-repo-link].

[Patrones glob de Bash]: https://facelessuser.github.io/wcmatch/glob/#syntax
@@ -282,7 +286,10 @@ separar este plugin de la documentación de
[license-link]: https://github.com/mondeja/mkdocs-include-markdown-plugin/blob/master/LICENSE
[platformdirs]: https://pypi.org/project/platformdirs/
[cibuildwheel-470]: https://github.com/pypa/cibuildwheel/issues/470
[cibuildwheel-475]: https://github.com/pypa/cibuildwheel/pull/475
[cibuildwheel-repo-link]: https://github.com/pypa/cibuildwheel
[es-readme-link]: https://github.com/mondeja/mkdocs-include-markdown-plugin/blob/master/locale/es/README.md
[fr-readme-link]: https://github.com/mondeja/mkdocs-include-markdown-plugin/blob/master/locale/fr/README.md
[`docs_dir`]: https://www.mkdocs.org/user-guide/configuration/#docs_dir
[Joe Rickerby]: https://github.com/joerick
[contribuidores]: https://github.com/mondeja/mkdocs-include-markdown-plugin/graphs/contributors
50 changes: 37 additions & 13 deletions locale/es/README.md.po
Original file line number Diff line number Diff line change
@@ -31,13 +31,13 @@ msgid "Acknowledgment"
msgstr "Agradecimiento"

msgid ""
"Joe Rickerby and contributors for [giving me the "
"permissions][cibuildwheel-470] to separate this plugin from the "
"documentation of [cibuildwheel][cibuildwheel-repo-link]."
"[Joe Rickerby] and [contributors] for [giving me the "
"permissions][cibuildwheel-470] to [separate this plugin][cibuildwheel-475] "
"from the documentation of [cibuildwheel][cibuildwheel-repo-link]."
msgstr ""
"Joe Rickerby y contribuidores por [darme los permisos][cibuildwheel-470] "
"para separar este plugin de la documentación de [cibuildwheel][cibuildwheel-"
"repo-link]."
"[Joe Rickerby] y [contribuidores] por [darme los permisos][cibuildwheel-470]"
" para [separar este plugin][cibuildwheel-475] de la documentación de "
"[cibuildwheel][cibuildwheel-repo-link]."

msgid ""
"[pypi-version-badge-link]: https://img.shields.io/pypi/v/mkdocs-include-"
@@ -408,11 +408,35 @@ msgid "[pypi-link]: https://pypi.org/project/mkdocs-include-markdown-plugin"
msgstr "[pypi-link]: https://pypi.org/project/mkdocs-include-markdown-plugin"

msgid ""
"<a name=\"recursive\" href=\"#include_recursive\">#</a> **recursive** "
"(*true*): When this option is disabled, included files are not processed for"
" recursive includes. Possible values are `true` and `false`."
"<a name=\"include_recursive\" href=\"#include_recursive\">#</a> "
"**recursive** (*true*): When this option is disabled, included files are not"
" processed for recursive includes. Possible values are `true` and `false`."
msgstr ""
"<a name=\"recursive\" href=\"#include_recursive\">#</a> **recursive** "
"(*true*): Cuando esta opción está deshabilitada, los archivos incluidos no "
"son procesados para incluir de forma recursiva. Los valores posibles son "
"`true` y `false`."
"<a name=\"include_recursive\" href=\"#include_recursive\">#</a> "
"**recursive** (*true*): Cuando esta opción está deshabilitada, los archivos "
"incluidos no son procesados para incluir de forma recursiva. Los valores "
"posibles son `true` y `false`."

msgid ""
"<a name=\"include-markdown_recursive\" href=\"#include-"
"markdown_recursive\">#</a> **recursive** (*true*): When this option is "
"disabled, included files are not processed for recursive includes. Possible "
"values are `true` and `false`."
msgstr ""
"<a name=\"include-markdown_recursive\" href=\"#include-"
"markdown_recursive\">#</a> **recursive** (*true*): Cuando esta opción está "
"deshabilitada, los archivos incluidos no son procesados para incluir de "
"forma recursiva. Los valores posibles son `true` y `false`."

msgid "[Joe Rickerby]: https://github.com/joerick"
msgstr "[Joe Rickerby]: https://github.com/joerick"

msgid ""
"[contributors]: https://github.com/mondeja/mkdocs-include-markdown-"
"plugin/graphs/contributors"
msgstr ""
"[contribuidores]: https://github.com/mondeja/mkdocs-include-markdown-"
"plugin/graphs/contributors"

msgid "[cibuildwheel-475]: https://github.com/pypa/cibuildwheel/pull/475"
msgstr "[cibuildwheel-475]: https://github.com/pypa/cibuildwheel/pull/475"
Loading