mirror of
https://github.com/groldsf/obsidian_check_plugin.git
synced 2026-07-22 05:37:48 +00:00
44 lines
No EOL
2.4 KiB
Markdown
44 lines
No EOL
2.4 KiB
Markdown
# Checkbox Sync for Obsidian
|
|
|
|
[](LICENSE)
|
|
[](https://github.com/groldsf/obsidian_check_plugin/releases)
|
|
[](https://github.com/groldsf/obsidian_check_plugin/releases)
|
|
|
|
**Checkbox Sync** is an [Obsidian](https://obsidian.md/) plugin that helps automate the management of checkbox states within hierarchical lists (parent ↔ children synchronization).
|
|
|
|
It automatically updates parent checkboxes based on their children's state, and optionally cascades changes from parent to children, providing flexibility for managing task lists and nested checklists.
|
|
|
|
<p align="center">
|
|
<img src="https://raw.githubusercontent.com/groldsf/obsidian_check_plugin/refs/heads/master/img/showcase.gif" alt="Checkbox Sync Demo: Parent state updates automatically based on children." width="400">
|
|
<br/>
|
|
<em>Example: Parent checkbox automatically reflects child completion status.</em>
|
|
</p>
|
|
|
|
[**➡️ Read the Full Documentation (English & Русский) for more examples and settings**](https://groldsf.github.io/obsidian_check_plugin/)
|
|
|
|
|
|
## Key Features
|
|
|
|
* Automatically check/uncheck parent based on children state.
|
|
* Automatically check/uncheck children when parent state changes manually.
|
|
* Configurable synchronization.
|
|
* Supports ordered and unordered lists.
|
|
* Respects list indentation for nested hierarchies.
|
|
|
|
## Quick Links
|
|
|
|
* [**Documentation Home**](https://groldsf.github.io/obsidian_check_plugin/)
|
|
* [Installation Guide](https://groldsf.github.io/obsidian_check_plugin/installation)
|
|
* [Settings Overview](https://groldsf.github.io/obsidian_check_plugin/settings)
|
|
* [Usage & Examples](https://groldsf.github.io/obsidian_check_plugin/usage)
|
|
* [Changelog](https://groldsf.github.io/obsidian_check_plugin/changelog)
|
|
* [Roadmap](https://groldsf.github.io/obsidian_check_plugin/roadmap)
|
|
* [Report an Issue / Suggestion](https://github.com/groldsf/obsidian_check_plugin/issues)
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome! Please see the [**Contributing Guide**](https://groldsf.github.io/obsidian_check_plugin/contributing) on our documentation site for details on how to help improve Checkbox Sync.
|
|
|
|
## License
|
|
|
|
This project is licensed under the 0BSD license. See the [LICENSE](LICENSE) file for details. |