---
title: Welcome
nav_order: 0
---
# Welcome to Checkbox Sync Documentation

- [English](#english)
- [Русский](#русский)

## English

**Checkbox Sync** is a plugin for [Obsidian](https://obsidian.md/) that helps automate the management of checkbox states within hierarchical lists in your notes.

It offers bidirectional synchronization options based on your settings:
1.  **Parent state from children:** If enabled, the parent checkbox state automatically reflects the completion status of its children.
2.  **Child state from parent:** If enabled, manually changing a parent checkbox's state will cascade that change down to all its children.

This provides flexibility in how you manage your task lists, allowing you to customize checkbox symbol recognition and synchronization behavior.

**Quick Links:**
*   [Usage and Examples](usage.md)
*   [Settings Explained](settings.md)
*   [Changelog](changelog.md)
*   [Roadmap](roadmap.md)
*   [Installation Guide](installation.md)
*   [Contributing Guide](contributing.md)
*   [Integration with Tasks plugin](Integration_with_Tasks_plugin.md)

### Acknowledgments
*   [Obsidian](https://obsidian.md/) — a platform for creating and organizing notes.
*   The project is based on the [obsidian-sample-plugin](https://github.com/obsidianmd/obsidian-sample-plugin) template.

---

## Русский

**Checkbox Sync** — это плагин для [Obsidian](https://obsidian.md/), который помогает автоматизировать управление состоянием чекбоксов в иерархических списках ваших заметок.

Он предлагает опции двунаправленной синхронизации в соответствии с вашими настройками:
1.  **Состояние родителя от детей:** Если включено, состояние родительского чекбокса автоматически отражает статус выполнения его дочерних элементов.
2.  **Состояние детей от родителя:** Если включено, ручное изменение состояния родительского чекбокса каскадно применит это изменение ко всем его дочерним элементам.

Это обеспечивает гибкость в управлении списками задач, позволяя вам настраивать распознавание символов чекбоксов и поведение синхронизации.

**Быстрые ссылки:**
*   [Использование и примеры](usage.md)
*   [Описание настроек](settings.md)
*   [История изменений](changelog.md)
*   [Планы (Roadmap)](roadmap.md)
*   [Руководство по установке](installation.md)
*   [Руководство для контрибьюторов](contributing.md)
*   [Интеграция с Tasks plugin](Integration_with_Tasks_plugin.md)

### Благодарности
*   [Obsidian](https://obsidian.md/) — платформа для создания и организации заметок.
*   Проект создан на основе шаблона [obsidian-sample-plugin](https://github.com/obsidianmd/obsidian-sample-plugin).