ivanruvalcaba
/
my-drafting-workflow
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

📝 Actualizar documentación

This commit is contained in:
Iván Ruvalcaba 2024-04-22 17:17:01 -06:00
parent d5a733e3fc
commit 3eea17f77c
1 changed files with 10 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
src/mdBook/plugins/mdBook-embedify.md
View File

@ -6,30 +6,17 @@ last_update: 2024-04-22
---
# mdBook-embedify
[mdBook-embedify] es un complemento para el preprocesador[^nota1] de *mdbook* que le permite insertar videos de [YouTube], fragmentos de código de [Codepen] o [GitHub Gist][github-gist] entre otros.
Un shortcode es un simple fragmento de código dentro de un archivo de contenido Markdown que el preprocesador renderizará como código HTML usando una plantilla predefinida.
## Inserción global
Some apps allow you to automatically embed to every chapter. You can do this by modifying `book.toml` file to enable them.
For example:
```toml
[preprocessor.embedify]
scroll-to-top.enable = true
```
<!-- embed ignore begin -->
> 💥Attention
> ℹ️ **Información**
>
> When you do this, you don't need to add `{% embed scroll-to-top %}` manually. It will be automatically added it to every chapter. If you do, it will be rendered twice.
>Hay ocasiones en que la especificación del lenguaje Markdown se queda corta, por lo que a menudo los autores de contenidos se ven obligados a añadir código HTML al contenido Markdown (por ejemplo, `<iframe>` de vídeo). Lo anterior puede contradecir la simplicidad de la sintaxis de Markdown.
<!-- embed ignore end -->
[mdBook-embedify] es un complemento para el preprocesador[^nota1] de *mdbook* que extiende la sintaxis de Markdown al proveer *shortcodes*[^nota2] los cuales facilitan la inserción de videos de [YouTube], fragmentos de código de [Codepen] o [GitHub Gist][github-gist] entre otros.
Below is a full list of apps that support global configuration:
## Shortcodes globales
Algunos shortcodes le permiten incluir automáticamente características y funcionalidades de forma global en cada capítulo. Para ello es necesario modificar el archivo `book.toml` para habilitarlos.
A continuación encontrará una lista completa de las funcionalidades que admiten la configuración global.
```toml
[preprocessor.embedify]
@ -54,8 +41,6 @@ giscus.lang = "en"
giscus.loading = "eager"
```
You can see more details about each app at its own page.
## Ignore Embeds
Sometimes you may want preprocessor to ignore some embeds.
@ -143,6 +128,8 @@ footer.message = "Copyright © 2024 • Created with ❤️ by [MR-Addict](https
[^nota1]: El preprocesador es un procesador de texto que manipula el texto de un archivo de código fuente, en este caso Markdown, como parte de la primera fase de traducción, es decir, la traducción del lenguaje Markdown a lenguaje HTML.
[^nota2]: Un «shortcode» es un simple fragmento de código dentro de un archivo de contenido Markdown que el preprocesador renderizará como código HTML usando una plantilla predefinida.
[mdBook-embedify]: https://github.com/mr-addict/mdbook-embedify
[YouTube]: https://www.youtube.com/