You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2.2 KiB
2.2 KiB
+++ title = "dōteki" description = "Add dynamic content to your GitHub profile through an intuitive plugin system." weight = 30
[taxonomies] tags = ["GitHub Actions", "automation", "Python"]
[extra] 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 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
- Add markers to your README:
{{ add_src_to_code_block(src="README.md") }}
<!-- blog start -->
<!-- blog end -->
- Configure what goes there:
{{ add_src_to_code_block(src="doteki.toml") }}
[sections.blog]
plugin = "feed"
url = "https://osc.garden/atom.xml" # Replace with your feed.
[sections.last_updated]
plugin = "current_date"
inline = true
- 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: