mirror of
https://github.com/welpo/tabi.git
synced 2025-10-11 07:46:15 +02:00
📝 misc: update git-sumi & dōteki projects
This commit is contained in:
parent
4be8a5634f
commit
6d44320f45
6 changed files with 135 additions and 85 deletions
|
@ -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.
|
||||
|
||||

|
||||
|
||||
#### [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.
|
||||
|
||||
[](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/)
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue