📝 misc: update git-sumi & dōteki projects

2024-11-25 15:17:28 +01:00
parent 4be8a5634f
commit 6d44320f45
6 changed files with 135 additions and 85 deletions
--- a/content/projects/doteki/index.ca.md
+++ b/content/projects/doteki/index.ca.md
@@ -10,29 +10,54 @@ tags = ["GitHub Actions", "automatització", "Python"]
 local_image = "projects/doteki/doteki_logo.webp"
 social_media_card = "social_cards/projects_doteki.jpg"
 canonical_url = "https://osc.garden/ca/projects/doteki/"
+add_src_to_code_block = true
 +++

-[**dōteki**](https://doteki.org/) és una eina dissenyada per donar vida als perfils de GitHub afegint contingut dinàmic de manera senzilla. Amb un arxiu de configuració TOML intuïtiu i un sistema de plugins versàtil, **dōteki** permet als usuaris mostrar contingut recent i automatitzat directament als seus perfils de GitHub.
+**dōteki** actualitza el teu perfil de GitHub automàticament. Afegeix les teves últimes publicacions del blog, la música que escoltes o qualsevol altre contingut dinàmic mitjançant plugins.

 ![logo de dōteki: un riu passant per un bosc de bambú](https://cdn.jsdelivr.net/gh/welpo/doteki@main/website/static/img/logo.png)

 #### [GitHub](https://github.com/welpo/doteki) • [Lloc web](https://doteki.org/) • [Documentació](https://doteki.org/docs/) {.centered-text}

-## Per què dōteki?
+## Com funciona

-**dōteki** destaca per la seva simplicitat i potència. És altament personalitzable i extensible, i està dissenyat per ser fàcil de configurar i utilitzar.
+1. Afegeix marcadors al teu README:

-## Característiques clau
+{{ add_src_to_code_block(src="README.md") }}
+```md
+<!-- blog start -->
+<!-- blog end -->
+```

- **Plug-and-Play**: Afegeix marcadors al teu README i utilitza un arxiu TOML per incorporar seccions de contingut dinàmic al teu perfil de GitHub.
- **Sistema de plugins extensible**: Des de mostrar les últimes publicacions del teu blog fins a compartir la música que has estat escoltant, el sistema de plugins permet infinites possibilitats. No trobes un plugin que s'ajusti a les teves necessitats? [Crea el teu propi](https://doteki.org/docs/developer-guide/plugin-standard)!
- [**Documentació exhaustiva**](https://doteki.org/docs/) amb informació detallada sobre com configurar i utilitzar **dōteki** i els seus plugins. Inclou [instruccions clares per als desenvolupadors](https://doteki.org/docs/developer-guide/) que vulguin contribuir al projecte.
- **Preparat per a l'automatització**: Utilitza l'[Acció de GitHub](https://github.com/welpo/doteki-action) per mantenir el teu perfil sempre actualitzat.
+2. Configura què hi va:

-## Refresca el teu perfil de GitHub
+{{ add_src_to_code_block(src="doteki.toml") }}
+```toml
+[sections.blog]
+plugin = "feed"
+url = "https://osc.garden/atom.xml"  # Substitueix amb el teu feed.

-Aprofita les capacitats dinàmiques de **dōteki** i transforma el teu perfil de GitHub en un aparador del teu treball més recent, pensaments i interessos.
+[sections.last_updated]
+plugin = "current_date"
+inline = true
+```

-[Configura **dōteki** en menys de 5 minuts](https://doteki.org/) i dóna vida al teu perfil de GitHub.
+3. Configura l'[Acció de GitHub](https://github.com/welpo/doteki-action).

-[![targeta de xarxes socials de dōteki](social_cards/projects_doteki.jpg)](https://doteki.org/)
+Això és tot! El teu README s'actualitzarà automàticament.
+
+## Característiques
+
+- **Sistema de plugins**: Mostra [entrades del blog](https://doteki.org/docs/plugins/feed), [música](https://doteki.org/docs/plugins/lastfm), o [crea el teu propi plugin](https://doteki.org/docs/developer-guide/plugin-standard)
+- **Configuració simple**: Un arxiu TOML, una Acció de GitHub
+- **Flexible**: Cada plugin té les seves pròpies opcions (ordre, entrades màximes, format…)
+- **[Documentació detallada](https://doteki.org/docs/)**: Informació detallada sobre com configurar i utilitzar **dōteki** i els seus plugins. Inclou [instruccions clares per als desenvolupadors](https://doteki.org/docs/developer-guide/) que vulguin contribuir.
+
+## Documentació
+
+Consulta la [documentació](https://doteki.org/docs/) per a:
+
+- [Guia d'inici](https://doteki.org/docs/)
+- [Plugins disponibles](https://doteki.org/docs/plugins/)
+- [Desenvolupament de plugins](https://doteki.org/docs/developer-guide/)
+- [Opcions de configuració](https://doteki.org/docs/configuration/)
--- a/content/projects/doteki/index.es.md
+++ b/content/projects/doteki/index.es.md
@@ -10,29 +10,54 @@ tags = ["GitHub Actions", "automatización", "Python"]
 local_image = "projects/doteki/doteki_logo.webp"
 social_media_card = "social_cards/projects_doteki.jpg"
 canonical_url = "https://osc.garden/es/projects/doteki/"
+add_src_to_code_block = true
 +++

-[**dōteki**](https://doteki.org/) es una herramienta diseñada para dar vida a los perfiles de GitHub añadiendo contenido dinámico de manera sencilla. Con un archivo de configuración TOML intuitivo y un versátil sistema de plugins, **dōteki** permite a los usuarios mostrar contenido reciente y automatizado directamente en sus perfiles de GitHub.
+**dōteki** actualiza tu perfil de GitHub automáticamente. Añade tus últimas publicaciones del blog, la música que escuchas o cualquier otro contenido dinámico mediante plugins.

 ![logo de dōteki: un río pasando por un bosque de bambú](https://cdn.jsdelivr.net/gh/welpo/doteki@main/website/static/img/logo.png)

 #### [GitHub](https://github.com/welpo/doteki) • [Sitio web](https://doteki.org/) • [Documentación](https://doteki.org/docs/) {.centered-text}

-## ¿Por qué dōteki?
+## Cómo funciona

-**dōteki** destaca por su simplicidad y potencia. Permite mostrar tu trabajo, intereses y personalidad en tu perfil de GitHub, siempre al día. Es altamente personalizable y extensible, y está diseñado para ser fácil de configurar y usar.
+1. Añade marcadores a tu README:

-## Características clave
+{{ add_src_to_code_block(src="README.md") }}
+```md
+<!-- blog start -->
+<!-- blog end -->
+```

- **Plug-and-Play**: Añade marcadores a tu README y utiliza un archivo TOML para incorporar secciones de contenido dinámico en tu perfil de GitHub.
- **Sistema de plugins extensible**: Desde mostrar las últimas publicaciones de tu blog hasta compartir la música que has estado escuchando, el sistema de plugins permite infinitas posibilidades. ¿No encuentras un plugin que se ajuste a tus necesidades? ¡[Crea tu propio plugin](https://doteki.org/docs/developer-guide/plugin-standard)!
- [**Documentación exhaustiva**](https://doteki.org/docs/) con información detallada sobre cómo configurar y usar **dōteki** y sus plugins. Incluye [instrucciones claras para los desarrolladores](https://doteki.org/docs/developer-guide/) que quieran contribuir al proyecto
- **Listo para la automatización**: Utiliza la [Acción de GitHub](https://github.com/welpo/doteki-action) para mantener tu perfil siempre actualizado.
+2. Configura qué va ahí:

-## Refresca tu perfil de GitHub
+{{ add_src_to_code_block(src="doteki.toml") }}
+```toml
+[sections.blog]
+plugin = "feed"
+url = "https://osc.garden/atom.xml"  # Reemplaza con tu feed.

-Aprovecha las capacidades dinámicas de **dōteki** y transforma tu perfil de GitHub en un escaparate de tu trabajo más reciente, pensamientos e intereses.
+[sections.last_updated]
+plugin = "current_date"
+inline = true
+```

-[Configura **dōteki** en menos de 5 minutos](https://doteki.org/) y da vida a tu perfil de GitHub.
+3. Configura la [Acción de GitHub](https://github.com/welpo/doteki-action).

-[![tarjeta de redes sociales de dōteki](social_cards/projects_doteki.jpg)](https://doteki.org/)
+¡Eso es todo! Tu README se actualizará automáticamente.
+
+## Características
+
+- **Sistema de plugins**: Muestra [entradas del blog](https://doteki.org/docs/plugins/feed), [música](https://doteki.org/docs/plugins/lastfm), o [crea tu propio plugin](https://doteki.org/docs/developer-guide/plugin-standard)
+- **Configuración simple**: Un archivo TOML, una Acción de GitHub
+- **Flexible**: Cada plugin tiene sus propias opciones (orden, entradas máximas, formato…)
+- **[Documentación detallada](https://doteki.org/docs/)**: Información detallada sobre cómo configurar y usar **dōteki** y sus plugins. Incluye [instrucciones claras para los desarrolladores](https://doteki.org/docs/developer-guide/) que quieran contribuir.
+
+## Documentación
+
+Consulta la [documentación](https://doteki.org/docs/) para:
+
+- [Guía de inicio rápido](https://doteki.org/docs/)
+- [Plugins disponibles](https://doteki.org/docs/plugins/)
+- [Desarrollo de plugins](https://doteki.org/docs/developer-guide/)
+- [Opciones de configuración](https://doteki.org/docs/configuration/)
--- a/content/projects/doteki/index.md
+++ b/content/projects/doteki/index.md
@@ -10,29 +10,56 @@ tags = ["GitHub Actions", "automation", "Python"]
 local_image = "projects/doteki/doteki_logo.webp"
 social_media_card = "social_cards/projects_doteki.jpg"
 canonical_url = "https://osc.garden/projects/doteki/"
+add_src_to_code_block = true
 +++

-[**dōteki**](https://doteki.org/) is a tool designed to breathe life into GitHub profiles by adding dynamic content effortlessly. By leveraging an intuitive TOML configuration file along with a versatile plugin system, **dōteki** empowers users to showcase fresh, automated content directly on their GitHub profiles.
+**dōteki** updates your GitHub profile README automatically. Add your latest blog posts, music you're listening to, or any other dynamic content using plugins.

 ![doteki logo: a river passing through a bamboo forest](https://cdn.jsdelivr.net/gh/welpo/doteki@main/website/static/img/logo.png)

 #### [GitHub](https://github.com/welpo/doteki) • [Website](https://doteki.org/) • [Documentation](https://doteki.org/docs/) {.centered-text}

-## Why dōteki?
+## How it works

-**dōteki** stands out for its simplicity and power, enabling you to dynamically showcase your work, interests and personality on your GitHub profile. It's designed to be easy to set up and use, while also being highly customizable and extensible.
+1. Add markers to your README:

-## Key Features
+{{ add_src_to_code_block(src="README.md") }}

- **Plug-and-Play**: Add markers to your README and use a TOML file for straightforward setup and easy management of dynamic content sections on your GitHub profile README.
- **Extensible plugin system**: From showcasing your latest blog posts to displaying your favourite music, the plugin system allows for endless possibilities. Can't find a plugin that suits your needs? [Create your own](https://doteki.org/docs/developer-guide/plugin-standard)!
- **Extensive documentation**: The [comprehensive documentation](https://doteki.org/docs/) provides detailed information on how to set up and use **dōteki** and its plugins. It includes [clear instructions for developers](https://doteki.org/docs/developer-guide/) looking to contribute.
- **Automation Ready**: Use the [GitHub Action](https://github.com/welpo/doteki-action) to keep your profile always up to date.
+```md
+<!-- blog start -->
+<!-- blog end -->
+```

-## Enhance Your GitHub Profile Today
+2. Configure what goes there:

-Embrace the dynamic capabilities of **dōteki** and transform your GitHub profile into a vibrant showcase of your latest work, thoughts, and interests.
+{{ add_src_to_code_block(src="doteki.toml") }}

-[Set up **dōteki** in less than 5 minutes](https://doteki.org/) and bring your GitHub profile to life.
+```toml
+[sections.blog]
+plugin = "feed"
+url = "https://osc.garden/atom.xml"  # Replace with your feed.

-[![dōteki social media card](social_cards/projects_doteki.jpg)](https://doteki.org/)
+[sections.last_updated]
+plugin = "current_date"
+inline = true
+```
+
+3. Set up the [GitHub Action](https://github.com/welpo/doteki-action).
+
+That's it! Your README will stay updated automatically.
+
+## Features
+
+- **Plugin system**: Show [blog posts](https://doteki.org/docs/plugins/feed), [music](https://doteki.org/docs/plugins/lastfm), or [build your own plugin](https://doteki.org/docs/developer-guide/plugin-standard)
+- **Simple setup**: One TOML file, one GitHub Action
+- **Flexible**: Each plugin has its own options (sort order, max entries, format…)
+- **[Extensive documentation](https://doteki.org/docs/)**: Detailed information on how to set up and use **dōteki** and its plugins. It includes [clear instructions for developers](https://doteki.org/docs/developer-guide/) looking to contribute.
+
+## Documentation
+
+Check the [docs](https://doteki.org/docs/) for:
+
+- [Getting started guide](https://doteki.org/docs/)
+- [Available plugins](https://doteki.org/docs/plugins/)
+- [Plugin development](https://doteki.org/docs/developer-guide/)
+- [Configuration options](https://doteki.org/docs/configuration/)