Preparing to create github pages wiki

docs/changelog.md

@@ -0,0 +1,20 @@
+# Changelog
+
+## [Unreleased]
+### Added
+- (Add new features for the next release here)
+
+### Changed
+- (Add changes in existing functionality here)
+
+### Fixed
+- (Add bug fixes here)
+
+## [Version.Number.Here] - YYYY-MM-DD  <-- Пример для прошлого релиза
+### Added
+- Feature X was added.
+### Fixed
+- Fixed bug Y.
+
+## [Initial Version] - YYYY-MM-DD
+- Initial release of Checkbox Sync.

docs/contributing.md

@@ -0,0 +1,36 @@
+# Contributing
+
+- [English](#english)
+- [Русский](#русский)
+
+## English
+
+If you want to make changes or improvements to the plugin:
+
+1.  **Fork** the repository.
+2.  **Clone** your fork locally.
+3.  **Install dependencies:** `npm install` (or yarn)
+4.  **Start development build:** `npm run dev` (or yarn dev)
+5.  Create a new branch: `git checkout -b feature/feature-name`
+6.  Make changes and commit: `git commit -m "feat: Description of changes"` (Try to follow [conventional commit messages](https://www.conventionalcommits.org/))
+7.  Push changes to your fork: `git push origin feature/feature-name`
+8.  Open a Pull Request in the original repository.
+
+Please ensure your code adheres to the existing style and include updates to the documentation (`/docs`) if your changes affect usage or settings.
+
+---
+
+## Русский
+
+Если вы хотите внести изменения или улучшения в плагин:
+
+1.  **Форкните** репозиторий.
+2.  **Клонируйте** ваш форк локально.
+3.  **Установите зависимости:** `npm install` (или yarn)
+4.  **Запустите сборку для разработки:** `npm run dev` (или yarn dev)
+5.  Создайте новую ветку: `git checkout -b feature/имя-функционала`
+6.  Внесите изменения и сделайте коммит: `git commit -m "feat: Описание изменений"` (Старайтесь следовать [conventional commit messages](https://www.conventionalcommits.org/))
+7.  Отправьте изменения в свой форк: `git push origin feature/имя-функционала`
+8.  Откройте Pull Request в оригинальном репозитории.
+
+Пожалуйста, убедитесь, что ваш код соответствует существующему стилю, и включите обновления документации (`/docs`), если ваши изменения затрагивают использование или настройки.

docs/index.md

@@ -0,0 +1,50 @@
+# 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.
+
+**Quick Links:**
+*   [Installation Guide](installation.md)
+*   [Usage and Examples](usage.md)
+*   [Settings Explained](settings.md)
+*   [Changelog](changelog.md)
+*   [Roadmap](roadmap.md)
+*   [Contributing Guide](contributing.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.  **Состояние детей от родителя:** Если включено, ручное изменение состояния родительского чекбокса каскадно применит это изменение ко всем его дочерним элементам.
+
+Это обеспечивает гибкость в управлении списками задач.
+
+**Быстрые ссылки:**
+*   [Руководство по установке](installation.md)
+*   [Использование и примеры](usage.md)
+*   [Описание настроек](settings.md)
+*   [История изменений](changelog.md)
+*   [Планы (Roadmap)](roadmap.md)
+*   [Руководство для контрибьюторов](contributing.md)
+
+### Благодарности
+*   [Obsidian](https://obsidian.md/) — платформа для создания и организации заметок.
+*   Проект создан на основе шаблона [obsidian-sample-plugin](https://github.com/obsidianmd/obsidian-sample-plugin).

docs/installation.md

@@ -0,0 +1,34 @@
+# Installation
+
+- [English](#english)
+- [Русский](#русский)
+
+## English
+
+### Via Community Plugins (Recommended)
+1. Open Obsidian and go to **Settings → Community plugins**.
+2. Click the **Browse** button, search for "Checkbox Sync", and click **Install**.
+3. Once installed, click **Enable**.
+
+### Manual Installation
+1. Go to the [releases page](https://github.com/groldsf/obsidian_check_plugin/releases) and download the latest `main.js`, `manifest.json`, and `styles.css` (if present).
+2. Create a new folder named `checkbox-sync` inside your vault's plugin folder: `<your-vault>/.obsidian/plugins/`.
+3. Copy the downloaded files into the `<your-vault>/.obsidian/plugins/checkbox-sync/` folder.
+4. Restart Obsidian.
+5. Open **Settings → Community plugins**, find **Checkbox Sync** in the list, and enable it.
+
+---
+
+## Русский
+
+### Через Плагины сообщества (Рекомендуется)
+1. Откройте Obsidian и перейдите в **Настройки → Плагины сообщества**.
+2. Нажмите кнопку **Обзор**, найдите "Checkbox Sync" и нажмите **Установить**.
+3. После установки нажмите **Включить**.
+
+### Ручная установка
+1. Перейдите на [страницу релизов](https://github.com/groldsf/obsidian_check_plugin/releases) и скачайте последние `main.js`, `manifest.json` и `styles.css` (при наличии).
+2. Создайте новую папку с именем `checkbox-sync` в папке плагинов вашего хранилища: `<ваше-хранилище>/.obsidian/plugins/`.
+3. Скопируйте загруженные файлы в папку `<ваше-хранилище>/.obsidian/plugins/checkbox-sync/`.
+4. Перезапустите Obsidian.
+5. Откройте **Настройки → Плагины сообщества**, найдите **Checkbox Sync** в списке и активируйте его.

docs/roadmap.md

@@ -0,0 +1,15 @@
+# Roadmap
+
+This document outlines the planned features and ideas for future development of the Checkbox Sync plugin.
+
+## Planned Features
+
+*   [ ] Feature A: Description of feature A.
+*   [ ] Feature B: Description of feature B.
+
+## Ideas Under Consideration
+
+*   Idea X: Brief description.
+*   Idea Y: Brief description.
+
+*Contributions and suggestions are welcome! Please open an issue to discuss new ideas.*

docs/settings.md

@@ -0,0 +1,34 @@
+# Settings
+
+- [English](#english)
+- [Русский](#русский)
+
+## English
+
+The plugin offers the following configuration options:
+
+-   **X-Only Mode**
+    -   **Enabled:** Only checkboxes marked with `x` (e.g., `- [x]`) are considered checked.
+    -   **Disabled:** Any character inside the checkbox (except a space) marks it as checked (e.g., `- [-]`, `- [?]`).
+-   **Update parent checkbox state automatically** (`enableAutomaticParentState`)
+    -   **Enabled (Default):** The state of a parent checkbox is automatically updated based on the state of its children (checked if all children are checked, unchecked otherwise).
+    -   **Disabled:** The parent checkbox state is not automatically changed when child states change.
+-   **Update child checkbox state automatically** (`enableAutomaticChildState`)
+    -   **Enabled (Default):** Manually changing the state of a parent checkbox automatically updates the state of all its direct and nested children to match.
+    -   **Disabled:** Manually changing a parent checkbox does not affect its children's state.
+
+---
+
+## Русский
+
+Плагин предлагает следующие параметры конфигурации:
+
+-   **Режим X-Only**
+    -   **Включен:** Только чекбоксы, отмеченные символом `x` (например, `- [x]`), считаются выполненными.
+    -   **Отключен:** Любой символ внутри чекбокса (кроме пробела) считается отметкой о выполнении (например, `- [-]`, `- [?]`).
+-   **Автоматически обновлять состояние родительского чекбокса** (`enableAutomaticParentState`)
+    -   **Включено (По умолчанию):** Состояние родительского чекбокса автоматически обновляется на основе состояния дочерних (отмечен, если все дочерние отмечены, не отмечен в противном случае).
+    -   **Отключено:** Состояние родительского чекбокса не изменяется автоматически при изменении состояния дочерних.
+-   **Автоматически обновлять состояние дочерних чекбоксов** (`enableAutomaticChildState`)
+    -   **Включено (По умолчанию):** Ручное изменение состояния родительского чекбокса автоматически обновляет состояние всех его прямых и вложенных дочерних элементов.
+    -   **Отключено:** Ручное изменение родительского чекбокса не влияет на состояние его дочерних элементов.

docs/usage.md

@@ -0,0 +1,58 @@
+# Usage and Examples
+
+- [English](#english)
+- [Русский](#русский)
+
+## English
+
+After activating the plugin, it automatically tracks and synchronizes checkboxes based on your settings. You can enable or disable the upward sync (parent from children) and downward sync (children from parent) independently via the settings to tailor the behavior to your preferred workflow.
+
+**Example 1: Parent state updates from children**
+*(Requires `enableAutomaticParentState` setting)*
+
+<img src="assets/showcase.gif" alt="Checking the last child causes the parent to become checked. Unchecking any child unchecks the parent." width="300">
+
+*Checking the last child causes the parent to become checked. Unchecking any child unchecks the parent.*
+
+**Example 2: Child state updates from parent**
+*(Requires `enableAutomaticChildState` setting)*
+
+<img src="assets/showcase2.gif" alt="Manually checking/unchecking the parent checkbox cascades the state change to all children." width="300">
+
+*Manually checking/unchecking the parent checkbox cascades the state change to all children.*
+
+### Supported Lists
+
+The plugin works with both ordered and unordered lists:
+-   **Unordered Lists** - Lists created with `-`, `+` or `*` markers
+-   **Ordered Lists** - Numbered lists (1., 2., etc.)
+
+The plugin respects list indentation, allowing for nested checkbox hierarchies at any level. It also attempts to handle checkboxes within embedded files (`![[...]]`), though behavior might depend on Obsidian's own handling of embeds.
+
+---
+
+## Русский
+
+После активации плагина, он автоматически отслеживает и синхронизирует чекбоксы в соответствии с вашими настройками. Вы можете независимо включать или отключать синхронизацию вверх (родитель от детей) и вниз (дети от родителя) с помощью настроек, чтобы адаптировать поведение под ваш рабочий процесс.
+
+**Пример 1: Состояние родителя обновляется от детей**
+*(Требует включенной настройки `enableAutomaticParentState`)*
+
+<img src="assets/showcase.gif" alt="Отметка последнего дочернего чекбокса приводит к отметке родительского. Снятие отметки с любого дочернего элемента снимает отметку с родительского." width="300">
+
+*Отметка последнего дочернего чекбокса приводит к отметке родительского. Снятие отметки с любого дочернего элемента снимает отметку с родительского.*
+
+**Пример 2: Состояние детей обновляется от родителя**
+*(Требует включенной настройки `enableAutomaticChildState`)*
+
+<img src="assets/showcase2.gif" alt="Ручная отметка/снятие отметки с родительского чекбокса каскадно применяет изменение ко всем дочерним элементам." width="300">
+
+*Ручная отметка/снятие отметки с родительского чекбокса каскадно применяет изменение ко всем дочерним элементам.*
+
+### Поддерживаемые списки
+
+Плагин работает как с нумерованными, так и с ненумерованными списками:
+-   **Ненумерованные списки** - Списки, созданные с помощью маркеров `-`, `+` или `*`
+-   **Нумерованные списки** - Списки с цифровой нумерацией (1., 2. и т.д.)
+
+Плагин учитывает отступы списков, позволяя создавать вложенные иерархии чекбоксов на любом уровне. Он также пытается корректно обрабатывать чекбоксы внутри встроенных файлов (`![[...]]`), хотя поведение может зависеть от собственной обработки встраиваний в Obsidian.