From 1ae1be87e1fde9809dccc84214f9ff79714fdc54 Mon Sep 17 00:00:00 2001
From: Kacper Kula <kulak@kulak.at>
Date: Mon, 17 Feb 2025 10:26:26 +0000
Subject: [PATCH] docs: adding documentation and bumping version

---
 CHANGELOG.md                               |  4 ++++
 docs/.vitepress/config.mts                 |  1 +
 docs/.vitepress/theme/components/Stats.vue |  6 +++---
 docs/comments.md                           | 25 ++++++++++++++++++++++
 manifest.json                              |  2 +-
 package.json                               |  2 +-
 versions.json                              |  3 ++-
 7 files changed, 37 insertions(+), 6 deletions(-)
 create mode 100644 docs/comments.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
index f7bcc2a..fb8198c 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,7 @@
+# 0.27.0 (2025-02-17)
+- Better syntax highlighting! Now it highlights SQL query parts
+- Support for comments. You can now add comments like `--` and `/* */` to you queries
+
 # 0.26.0 (2025-02-16)
 - Better language parser! Reworked from the ground up, now SQLSeal uses Ohm.js parser which works much better and opens much more possibilities (like syntax highlighting also introduced in this version).
 - Syntax highlighting! Your SQLSeal text is now being highlighted helping you spot potential syntax issues quickly. The highlighting will be iterated on so please join discussion on our Discord!
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
index 95197f4..cea7155 100644
--- a/docs/.vitepress/config.mts
+++ b/docs/.vitepress/config.mts
@@ -29,6 +29,7 @@ export default defineConfig({
           { text: 'Demo Vault', link: '/demo-vault' },
           { text: 'Changing Render Methods', link: '/changing-render-method'},
           { text: 'Using properties', link: '/using-properties' },
+          { text: 'Comments', link: '/comments' },
           { text: 'Query Vault Content', link: '/query-vault-content' },
           { text: 'Query Markdown Tables', link: '/query-markdown-tables'},
           { text: 'Inline codeblocks', link: '/inline-codeblocks' },
diff --git a/docs/.vitepress/theme/components/Stats.vue b/docs/.vitepress/theme/components/Stats.vue
index 70f5554..796528d 100644
--- a/docs/.vitepress/theme/components/Stats.vue
+++ b/docs/.vitepress/theme/components/Stats.vue
@@ -6,17 +6,17 @@ const stats = [
     icon: '📥'
   },
   {
-    number: '39+',
+    number: '48+',
     label: 'Releases',
     icon: '📦'
   },
   {
-    number: '51+',
+    number: '64+',
     label: 'GitHub Stars',
     icon: '⭐'
   },
   {
-    number: '48+',
+    number: '50+',
     label: 'Discord Members',
     icon: '🤝'
   }
diff --git a/docs/comments.md b/docs/comments.md
new file mode 100644
index 0000000..7d3ada2
--- /dev/null
+++ b/docs/comments.md
@@ -0,0 +1,25 @@
+# Comments
+You can add comments to document your query. This can help you document your thought process and make it easier to share additional information when sharing your query with other. You can also use comments to disable (comment out) specific parts of your query you don't want to use at the moment but want to preserve for later.
+SQLSeal supports 2 types of comments:
+- SQL style `--` comment which comments everything until the end of the line
+- Block comment `/* */` which comments everything between opening `/*` mark and `*/` closing mark
+
+
+```sqlseal
+TABLE a = file(file.csv)
+-- TABLE b = file(file2.csv)
+
+/*
+GRID
+NO REFRESH
+*/
+
+SELECT *
+FROM a
+-- WHERE value > 5
+```
+
+In the example above:
+- Table b is not being loaded - that line is commented out
+- GRID and NO REFRESH are disabled and will take no effect
+- `WHERE value > 5` is disabled - there will be no filtering
\ No newline at end of file
diff --git a/manifest.json b/manifest.json
index 0a34047..006db0c 100644
--- a/manifest.json
+++ b/manifest.json
@@ -1,7 +1,7 @@
 {
 	"id": "sqlseal",
 	"name": "SQLSeal",
-	"version": "0.26.0",
+	"version": "0.27.0",
 	"minAppVersion": "0.15.0",
 	"description": "Use SQL in your notes to query your vault files and CSV content.",
 	"author": "hypersphere",
diff --git a/package.json b/package.json
index 0aac2b2..9a5c63f 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "sqlseal",
-  "version": "0.26.0",
+  "version": "0.27.0",
   "description": "A plugin for Obsidian that allows you to run SQL queries on your notes.",
   "main": "main.js",
   "scripts": {
diff --git a/versions.json b/versions.json
index 5e1ad76..8c885e4 100644
--- a/versions.json
+++ b/versions.json
@@ -47,5 +47,6 @@
 	"0.24.1": "0.15.0",
 	"0.24.2": "0.15.0",
 	"0.25.0": "0.15.0",
-	"0.26.0": "0.15.0"
+	"0.26.0": "0.15.0",
+	"0.27.0": "0.15.0"
 }
\ No newline at end of file