Merge pull request #6 from vburzynski/update-documentation

Update documentation, Test Vault, and Fix to support ITS Theme

.commitlintrc.js

@@ -7,18 +7,18 @@ module.exports = {
       2,
       'always',
       [
-        'build',
-        'chore',
-        'ci',
-        'docs',
-        'feat',
-        'fix',
-        'perf',
-        'refactor',
-        'release',
-        'revert',
-        'style',
-        'test',
+        'feat', // new feature
+        'test', // adding or correcting tests
+        'fix', // bug fix
+        'refactor', // changes that neither fixes a bug nor adds a feature
+        'perf', // changes that improve performance
+        'chore', // changes that don't modify src or test files
+        'style', // changes that do not affect the meaning of the code
+        'docs', // changes to documentation
+        'ci', // change to Continuous Integrations (CI) files and scripts
+        'build', // changes that affect the build system or external dependencies
+        'revert', // reverts a previous commit
+        'release', // version and other trivial changes preparing for a release
       ],
     ],
   },

.gitignore

@@ -20,3 +20,9 @@ data.json
 
 # Exclude macOS Finder (System Explorer) View States
 .DS_Store
+
+# Exclude some test vault files
+test-vault/.obsidian/plugins/**/data.json
+test-vault/.obsidian/app.json
+test-vault/.obsidian/appearance.json
+test-vault/.obsidian/workspace.json

README.md

@@ -17,6 +17,10 @@ Please note, that this plugin assumes that you have either installed an Obsidian
 custom task status styling (such as Things or Minimal), or that you've created and applied your own
 CSS snippet to style tasks.
 
+- [Setup AnuPpuccin Theme](./docs/Setup%20AnuPpuccin%20Theme.md)
+- [Setup ITS Theme](./docs/Setup%20ITS%20Theme.md)
+- [Setup Minimal Theme](./docs/Setup%20Minimal%20Theme.md)
+
 ## Why this plugin?
 
 - keyboard driven

docs/Setup AnuPpuccin Theme.md

@@ -0,0 +1,18 @@
+# Setup AnuPpuccin
+
+## Setup
+
+1. Install and activate the **AnuPpuccin** theme
+2. Install the **Style Settings** Plugin
+3. Open the settings for the Style Settings plugin
+4. Locate the checkbox settings: `AnuPpuccin` ▶ `File Editor & Markdown Elements` ▶ `Checkboxes`
+5. Toggle `Enable Custom Checkboxes` to active
+6. Toggle `Enable Speech Bubbles` to active
+7. Install the [Task Status](https://github.com/vburzynski/obsidian-task-status) plugin
+8. Open the settings for the **Task Status** plugin
+9. Click the **Clear List** button to clear the default configuration
+10. Click the **AnuPpucin Theme** button to add the configuration
+
+## Resources
+
+- https://github.com/AnubisNekhet/AnuPpuccin/

docs/Setup Border Theme.md

@@ -0,0 +1,13 @@
+# Setup Border Theme
+
+## Setup
+
+1. Install and activate the **Border Theme**
+2. Install the [Task Status](https://github.com/vburzynski/obsidian-task-status) plugin
+3. Open the settings for the **Task Status** plugin
+4. Click the **Clear List** button to clear the default configuration
+5. Click the **Border Theme** button to add the configuration
+
+## Resources
+
+- https://github.com/Akifyss/obsidian-border

docs/Setup ITS Theme.md

@@ -0,0 +1,13 @@
+# Setup ITS Theme
+
+## Setup
+
+1. Install and activate the **ITS Theme**
+2. Install the [Task Status](https://github.com/vburzynski/obsidian-task-status) plugin
+3. Open the settings for the **Task Status** plugin
+4. Click the **Clear List** button to clear the default configuration
+5. Click the **ITS Theme with SIRvb Checkboxes** button to add the configuration
+
+## Resources
+
+- <https://github.com/SlRvb/Obsidian--ITS-Theme/blob/main/Guide/Alternate-Checkboxes.md>

docs/Setup Minimal Theme.md

@@ -0,0 +1,13 @@
+# Setup Minimal Theme
+
+## Setup
+
+1. Install and activate the **Minimal Theme**
+2. Install the [Task Status](https://github.com/vburzynski/obsidian-task-status) plugin
+3. Open the settings for the **Task Status** plugin
+4. Click the **Clear List** button to clear the default configuration
+5. Click the **Minimal Theme** button to add the configuration
+
+## Resources
+
+- https://github.com/kepano/obsidian-minimal

src/modals/quick-action-modal.ts

@@ -45,15 +45,27 @@ export default class QuickActionModal extends SuggestModal<CheckboxOption> {
       textAlign: 'center',
     });
 
+    // set a bunch of attributes so that the preview will be targeted by various themes
+    el.setAttribute('data-task', option.character);
+    el.classList.add('task-list-item');
+    if (option.character !== ' ') {
+      el.classList.add('is-checked');
+    }
+
     // show a preview of the checkbox
     const input = el.createEl('input', {
       attr: {
         'type': 'checkbox',
         'data-task': option.character,
       },
     });
+
+    // set a bunch of attributes so that the preview will be targeted by various themes
     input.classList.add('task-list-item');
     input.checked = option.character !== ' ';
+    if (option.character !== ' ') {
+      input.classList.add('is-checked');
+    }
 
     // show the name of the checkbox option
     const span = el.createEl("span", { text: option.title });

test-vault/.obsidian/community-plugins.json

@@ -0,0 +1,7 @@
+[
+  "obsidian-task-status",
+  "open-vscode",
+  "obsidian42-brat",
+  "task-status",
+  "obsidian-style-settings"
+]

test-vault/.obsidian/core-plugins-migration.json

@@ -0,0 +1,30 @@
+{
+  "file-explorer": true,
+  "global-search": true,
+  "switcher": true,
+  "graph": true,
+  "backlink": true,
+  "canvas": true,
+  "outgoing-link": true,
+  "tag-pane": true,
+  "page-preview": true,
+  "daily-notes": true,
+  "templates": true,
+  "note-composer": true,
+  "command-palette": true,
+  "slash-command": false,
+  "editor-status": true,
+  "bookmarks": true,
+  "markdown-importer": false,
+  "zk-prefixer": false,
+  "random-note": false,
+  "outline": true,
+  "word-count": true,
+  "slides": false,
+  "audio-recorder": false,
+  "workspaces": false,
+  "file-recovery": true,
+  "publish": false,
+  "sync": false,
+  "properties": false
+}

test-vault/.obsidian/core-plugins.json

@@ -0,0 +1,30 @@
+{
+  "file-explorer": true,
+  "global-search": true,
+  "switcher": true,
+  "graph": true,
+  "backlink": true,
+  "canvas": true,
+  "outgoing-link": true,
+  "tag-pane": true,
+  "page-preview": true,
+  "daily-notes": true,
+  "templates": true,
+  "note-composer": true,
+  "command-palette": true,
+  "slash-command": false,
+  "editor-status": true,
+  "bookmarks": true,
+  "markdown-importer": false,
+  "zk-prefixer": false,
+  "random-note": false,
+  "outline": true,
+  "word-count": true,
+  "slides": false,
+  "audio-recorder": false,
+  "workspaces": false,
+  "file-recovery": true,
+  "publish": false,
+  "sync": false,
+  "properties": false
+}

test-vault/.obsidian/hotkeys.json

@@ -0,0 +1,45 @@
+{
+  "editor:cycle-list-checklist": [
+    {
+      "modifiers": [
+        "Mod",
+        "Shift"
+      ],
+      "key": "B"
+    }
+  ],
+  "task-status:change-task-status": [
+    {
+      "modifiers": [
+        "Mod",
+        "Shift"
+      ],
+      "key": "L"
+    }
+  ],
+  "editor:swap-line-down": [
+    {
+      "modifiers": [
+        "Alt"
+      ],
+      "key": "ArrowDown"
+    }
+  ],
+  "editor:swap-line-up": [
+    {
+      "modifiers": [
+        "Alt"
+      ],
+      "key": "ArrowUp"
+    }
+  ],
+  "editor:toggle-source": [
+    {
+      "modifiers": [
+        "Mod",
+        "Shift"
+      ],
+      "key": "E"
+    }
+  ]
+}

test-vault/.obsidian/plugins/obsidian-style-settings/manifest.json

@@ -0,0 +1,10 @@
+{
+	"id": "obsidian-style-settings",
+	"name": "Style Settings",
+	"version": "1.0.9",
+	"minAppVersion": "0.11.5",
+	"description": "Offers controls for adjusting theme, plugin, and snippet CSS variables.",
+	"author": "mgmeyers",
+	"authorUrl": "https://github.com/mgmeyers/obsidian-style-settings",
+	"isDesktopOnly": false
+}