iokode / butterfly

IOKode blog engine

Spanish

Butterfly es el motor de blogging utilizado en el blog IOKode. Código abierto.

Butterfly se compone de dos proyectos .NET, el primero de ellos, llamado IOKode.Butterfly.GitHubService es una biblioteca de clases que obtiene las entradas del repositorio iokode/blog mediante el API GraphQL de GitHub.

El segundo proyecto, llamado simplemente IOKode.Butterfly es una aplicación web ASP.NET Core que utiliza la plantilla del repositorio iokode/template y la rellena con los datos obtenidos a través de IOKode.Butterfly.GitHubService.

Tanto la plantilla como el servicio están diseñados específicamente para IOKode, con rutas y consultas hardcodeadas a los repositorios de IOKode, por lo que aunque es posible utilizarlo para otro blog, requeriría trabajo de adaptación.

Debido a que la mascota del blog es una mariposa, he decidido nombrar este proyecto como Butterfly.

English

Butterfly is the blogging engine used in IOKode blog. Open source.

Buttefly consists of two .NET projects, the first one, IOKode.Butterfly.GitHubService is a class library that get post entries from iokode/blog repository using the GitHub GraphQL API.

The second one, IOKode.Butterfly is an ASP.NET Core web application that uses the template from iokode/template repository and fill data from IOKode.Butterfly.GitHubService.

You can use the service and the template in any project, but both are designed to be used in IOKode, with some queries and routes hardcoded.

Butterfly name comes from the IOKode's pet, that is a butterfly.

butterfly's Issues

Customize listen

Allow listening address and UNIX Socket

Change publishing format

Markdown has some limitations about embedding content or making alerts. Investigate about alternatives (maybe AsciiDoc?) and update publishing format.

While GitHub Discussions only allow Markdown format, I should let GH Discussions only for comments, and publish the content inside the repository. This will allow someone to make pull requests fixing content (cc/ @JaviAibar).

Decouple social links and other blog links from template

Allow to update social and other blog links directly from GitHub without the need to recompile application.

Configure GitHub actions

Use GH actions to automatically create images when pushing main branch.

Store blog in repository code instead of GitHub Discussions

Remain discussions for comments, but store post text inside repository code.

Advantages:

• GitHub repository code will not be indexed like the entry, helping me to index the blog instead of GitHub discussions.
• Allow pull-request to fix text in the post.
• Allow use other formats like asciidoc instead of only markdown.

Cookie alert

Analytics (#10) requires cookies.

Use Asciidoc as publishing format

RSS Feed

Legal page

Analytics

Update to .NET 7

Blazor SSR

Pingback

Response cache

When a blog request occurs, Butterfly queries GitHub API and wait the API response, then it composes the HTML document and it sends the blog response.

Querying GitHub API takes time, so we Butterfly should cache the response and avoid querying GitHub API multiple times to get the same data.

Add favicon