dōteki

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.

GitHub • Website • Documentation

How it works

1. Add markers to your README:

<!-- blog start -->
<!-- blog end -->

2. Configure what goes there:

[sections.blog]
plugin = "feed"
url = "https://osc.garden/atom.xml"  # Replace with your feed.

[sections.last_updated]
plugin = "current_date"
inline = true

3. Set up the GitHub Action.

That’s it! Your README will stay updated automatically.

Features

• Plugin system: Show blog posts, music, or build your own plugin
• Simple setup: One TOML file, one GitHub Action
• Flexible: Each plugin has its own options (sort order, max entries, format…)
• Extensive documentation: Detailed information on how to set up and use dōteki and its plugins. It includes clear instructions for developers looking to contribute.

Documentation

Check the docs for:

• Getting started guide
• Available plugins
• Plugin development
• Configuration options