Merge pull request #19 from onflow/nialexsan/search

.env.example

@@ -0,0 +1,6 @@
+
+TYPESENSE_NODE="<TYPESENSE_NODE>"
+TYPESENSE_SEARCH_ONLY_API_KEY="<TYPESENSE_SEARCH_ONLY_API_KEY>"
+TYPESENSE_ADMIN_API_KEY="<TYPESENSE_ADMIN_API_KEY>"
+
+MIXPANEL_PROJECT_TOKEN="<MIXPANEL_PROJECT_TOKEN>"

.github/workflows/deploy.yml

@@ -0,0 +1,47 @@
+name: Test build & Scrape
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+env:
+  TYPESENSE_NODE: ${{ vars.TYPESENSE_NODE }}
+  TYPESENSE_ADMIN_API_KEY: ${{ secrets.TYPESENSE_ADMIN_API_KEY }}
+
+jobs:
+  build:
+    name: Test build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: npm
+
+      - name: Install dependencies
+        run: npm i
+
+      - name: Build website
+        run: npm run build
+
+      - name: Run DocSearch Scraper
+        uses: celsiusnarhwal/typesense-scraper@v2
+        with:
+          # The secret containing your Typesense API key. Required.
+          api-key: ${{ env.TYPESENSE_ADMIN_API_KEY }}
+
+          # The hostname or IP address of your Typesense server. Required.
+          host: ${{ env.TYPESENSE_NODE }}
+
+          # The port on which your Typesense server is listening. Optional. Default: 8108.
+          port: 443
+
+          # The protocol to use when connecting to your Typesense server. Optional. Default: http.
+          protocol: https
+
+          # The path to your DocSearch config file. Optional. Default: docsearch.config.json.
+          config: docsearch.config.json

.github/workflows/scrape.yml

@@ -0,0 +1,33 @@
+name: DocSearch Scraper
+
+on:
+  workflow_dispatch:
+
+env:
+  TYPESENSE_NODE: ${{ vars.TYPESENSE_NODE }}
+  TYPESENSE_ADMIN_API_KEY: ${{secrets.TYPESENSE_ADMIN_API_KEY}}
+
+jobs:
+  crawl:
+    name: Crawl Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Run DocSearch Scraper
+        uses: celsiusnarhwal/typesense-scraper@v2
+        with:
+          # The secret containing your Typesense API key. Required.
+          api-key: ${{ env.TYPESENSE_ADMIN_API_KEY }}
+
+          # The hostname or IP address of your Typesense server. Required.
+          host: ${{ env.TYPESENSE_NODE }}
+
+          # The port on which your Typesense server is listening. Optional. Default: 8108.
+          port: 443
+
+          # The protocol to use when connecting to your Typesense server. Optional. Default: http.
+          protocol: https
+
+          # The path to your DocSearch config file. Optional. Default: docsearch.config.json.
+          config: docsearch.config.json

.gitignore

@@ -18,4 +18,4 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
-
+.env

docsearch.config.json

@@ -0,0 +1,46 @@
+{
+  "index_name": "cadence_lang",
+  "start_urls": [
+    "https://cadence-lang.org/"
+  ],
+  "sitemap_urls": [
+    "https://cadence-lang.org/sitemap.xml"
+  ],
+  "sitemap_alternate_links": true,
+  "stop_urls": [
+    "/tests"
+  ],
+  "selectors": {
+    "lvl0": {
+      "selector": "(//ul[contains(@class,'menu__list')]//a[contains(@class, 'menu__link menu__link--sublist menu__link--active')]/text() | //nav[contains(@class, 'navbar')]//a[contains(@class, 'navbar__link--active')]/text())[last()]",
+      "type": "xpath",
+      "global": true,
+      "default_value": "Documentation"
+    },
+    "lvl1": "article h1, header h1",
+    "lvl2": "article h2",
+    "lvl3": "article h3",
+    "lvl4": "article h4",
+    "lvl5": "article h5, article td:first-child",
+    "lvl6": "article h6",
+    "text": "article p, article li, article td:last-child"
+  },
+  "strip_chars": " .,;:#",
+  "custom_settings": {
+    "separatorsToIndex": "_",
+    "attributesForFaceting": [
+      "language",
+      "version",
+      "type",
+      "docusaurus_tag"
+    ],
+    "attributesToRetrieve": [
+      "hierarchy",
+      "content",
+      "anchor",
+      "url",
+      "url_without_anchor",
+      "type"
+    ]
+  }
+}

docusaurus.config.js

@@ -1,12 +1,15 @@
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
-
+require('dotenv').config();
 const lightCodeTheme = require('prism-react-renderer/themes/github');
 const darkCodeTheme = require('prism-react-renderer/themes/dracula');
 
 const theme = require('shiki/themes/nord.json');
 const { remarkCodeHike } = require('@code-hike/mdx');
 
+const hasTypesense =
+  process.env.TYPESENSE_NODE && process.env.TYPESENSE_SEARCH_ONLY_API_KEY;
+
 /** @type {import('@docusaurus/types').Config} */
 const config = {
   title: 'Cadence',
@@ -82,6 +85,8 @@ const config = {
     ],
   ],
 
+  themes: [hasTypesense && 'docusaurus-theme-search-typesense'].filter(Boolean),
+
   themeConfig:
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
     ({
@@ -169,6 +174,28 @@ const config = {
         theme: lightCodeTheme,
         darkTheme: darkCodeTheme,
       },
+      typesense: hasTypesense && {
+        // Replace this with the name of your index/collection.
+        // It should match the "index_name" entry in the scraper's "config.json" file.
+        typesenseCollectionName: 'cadence_lang',
+
+        typesenseServerConfig: {
+          nodes: [
+            {
+              host: process.env.TYPESENSE_NODE,
+              port: 443,
+              protocol: 'https',
+            },
+          ],
+          apiKey: process.env.TYPESENSE_SEARCH_ONLY_API_KEY,
+        },
+
+        // Optional: Typesense search parameters: https://typesense.org/docs/0.24.0/api/search.html#search-parameters
+        typesenseSearchParameters: {},
+
+        // Optional
+        contextualSearch: true,
+      },
     }),
 };