chore: embed cruncher in docs

IamShobe · Jan 4, 2025 · 839b970 · 839b970
1 parent c062557
commit 839b970
Show file tree

Hide file tree

Showing 8 changed files with 477 additions and 1 deletion.
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -20,6 +20,13 @@ jobs:
     steps:
       - name: Checkout your repository using git
         uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+      - name: Install, and build the main Cruncher app
+        run: |
+          pnpm install
+          pnpm build
+
       - name: Install, build, and upload your site
         uses: withastro/action@v3
         with:

diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs
@@ -1,11 +1,13 @@
 // @ts-check
 import { defineConfig } from 'astro/config';
+import react from '@astrojs/react';
 import starlight from '@astrojs/starlight';
 
 // https://astro.build/config
 export default defineConfig({
 	site: 'https://cruncher.iamshobe.com',
 	integrations: [
+		react(),
 		starlight({
 			title: 'Cruncher',
 			logo: {

diff --git a/docs/package.json b/docs/package.json
@@ -10,8 +10,10 @@
     "astro": "astro"
   },
   "dependencies": {
+    "@astrojs/react": "^4.1.2",
     "@astrojs/starlight": "^0.30.3",
     "astro": "^5.0.2",
+    "cruncher": "link:..",
     "sharp": "^0.32.5"
   }
 }
diff --git a/docs/pnpm-lock.yaml b/docs/pnpm-lock.yaml
diff --git a/docs/src/content/docs/qql_reference/qql.md → docs/src/content/docs/qql_reference/qql.mdx b/docs/src/content/docs/qql_reference/qql.md → docs/src/content/docs/qql_reference/qql.mdx
@@ -3,4 +3,22 @@ title: QQL (Quick Query Language)
 description: The main query language inside `Cruncher` - it's main goal is to have a quick - easy to learn language - that's powerful enought to allow power users access to enhanced capabilities over that data.
 ---
 
-QQL is the main query language inside `Cruncher` - it's main goal is to have a quick - easy to learn language - that's powerful enought to allow power users access to enhanced capabilities over that data.
+import {LocalContent} from 'cruncher';
+
+QQL is the main query language inside `Cruncher` - it's main goal is to have a quick - easy to learn language - that's powerful enought to allow power users access to enhanced capabilities over that data.
+
+The query language was heavily inspired from Splunk (SPL2) and Kusto (KQL).  
+
+
+<hr/>
+<br/>
+
+## Example
+
+Here you can see cruncher embedded.  
+It will return the `name` and `address` of all `developers` found in mocked logs:
+
+
+<LocalContent client:only="react" query={"developer | table name, address"}>
+    <p>Loading...</p>
+</LocalContent>
diff --git a/lib/main.ts b/lib/main.ts
@@ -1,4 +1,5 @@
 export {default as MainContent} from "~core/MainContent";
+export {LocalContent} from "~bundle/LocalContent";
 
 // cosumers
 export {DateType} from "~core/store/dateState";

diff --git a/src/bundle/LocalContent.tsx b/src/bundle/LocalContent.tsx
@@ -0,0 +1,12 @@
+import { MockController } from '~adapters/local/controller';
+import MainContent from '~core/MainContent';
+
+export const LocalContent = ({query}: {query: string}) => {
+    return (
+        <main style={{width: "100%", height: 500, display: "flex"}}>
+            <MainContent controller={MockController}
+                initialQuery={query}
+            />
+        </main>
+    );
+}
diff --git a/src/components/ui/editor/Editor.tsx b/src/components/ui/editor/Editor.tsx
@@ -211,6 +211,7 @@ export const Editor = React.forwardRef<HTMLTextAreaElement, EditorProps>(({ valu
         placeholder="Type your query here..."
         value={value}
         ref={setReferenceElement}
+        data-1p-ignore="disabled"
         data-enable-grammarly="false"
         style={{
           position: "relative",