obsidian-plugin/groldsf_obsidian_check_plugin
1
0
Fork 0
mirror of https://github.com/groldsf/obsidian_check_plugin.git synced 2026-07-22 05:37:48 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

upd docs

Browse source
This commit is contained in:
Grol Grol 2025-05-18 21:26:01 +03:00
parent a7cfbd70df
commit 9398dc67ec
3 changed files with 14 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -26,6 +26,7 @@ It automatically updates parent checkboxes based on their children's state, and
* Respects list indentation for nested hierarchies.
* Flexible checkbox symbol interpretation (define checked/unchecked/ignored symbols).
* Option to disable automatic sync on file open.
* File Ignore Rules.
## Quick Links
@ -43,4 +44,4 @@ Contributions are welcome! Please see the [**Contributing Guide**](https://grold
## License
This project is licensed under the 0BSD license. See the [LICENSE](LICENSE) file for details.
This project is licensed under the 0BSD license. See the [LICENSE](LICENSE) file for details.

7
docs/changelog.md
View file

@ -4,6 +4,11 @@ nav_order: 3
---
# Changelog
## [1.2.0] - 2025-XX-XX
### Added
- Added Feature: **Logging Toggle:** Add a setting to enable/disable detailed logging for debugging purposes.
- added Feature **File/Folder Scope Filter:** Implement settings to include or exclude specific files or folders where the plugin should be active.
## [1.1.0] - 2025-05-05
### Added
- Added Feature: Flexible Checkbox Symbol Configuration[#11](https://github.com/groldsf/obsidian_check_plugin/issues/11).
@ -67,4 +72,4 @@ nav_order: 3
- Fixed cursor and scroll bug.
## [1.0.0] - 2025-02-03
- Initial release of Checkbox Sync.
- Initial release of Checkbox Sync.

6
docs/settings.md
View file

@ -51,6 +51,12 @@ These settings control when and how the synchronization logic runs.
- **Enabled:** Automatically synchronizes checkbox states when files are loaded/opened and immediately after plugin settings are applied. This ensures consistency but might have performance implications on very large vaults or files. *(Requires Obsidian restart or settings reload to take full effect)*.
- **Disabled (Default):** Synchronization only occurs when you *manually* change a checkbox's state within Obsidian. This is the default behavior to minimize potential performance impact.
### File Scope & Filtering
- **File ignore Rules (.gitignore style)**
- This setting allows you to define which files and folders Checkbox Sync should process. If the list of patterns is empty, the plugin will operate on all markdown files in your vault.
- The filtering uses **.gitignore syntax** and is powered by the [`ignore`](https://github.com/kaelzhang/node-ignore) library.
### Dev
- **Enable console log**