Skip to content

Commit

Permalink
feat: add algolia search (#207)
Browse files Browse the repository at this point in the history
# Description

Add Algolia search functionality to ZKsync Docs.
  • Loading branch information
itsacoyote committed Sep 4, 2024
1 parent 5195544 commit 7213406
Show file tree
Hide file tree
Showing 6 changed files with 80 additions and 21 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/deploy-preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ jobs:
build_and_preview:
env:
NUXT_UI_PRO_LICENSE: ${{ secrets.NUXT_UI_PRO_LICENSE }}
ALGOLIA_SEARCH_API_KEY: ${{ secrets.ALGOLIA_SEARCH_API_KEY }}
ALGOLIA_APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }}
if: ${{ github.event_name == 'workflow_dispatch' || github.event.pull_request.head.repo.full_name == github.repository }}
runs-on: ubuntu-latest
outputs:
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/deploy-prod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ jobs:
build_and_deploy:
env:
NUXT_UI_PRO_LICENSE: ${{ secrets.NUXT_UI_PRO_LICENSE }}
ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}
ALGOLIA_APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }}
if: ${{ github.event.repository.full_name == github.repository }}
runs-on: ubuntu-latest
environment: production
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/deploy-staging.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ jobs:
build_and_deploy:
env:
NUXT_UI_PRO_LICENSE: ${{ secrets.NUXT_UI_PRO_LICENSE }}
ALGOLIA_SEARCH_API_KEY: ${{ secrets.ALGOLIA_SEARCH_API_KEY }}
ALGOLIA_APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }}
if: ${{ github.event.repository.full_name == github.repository }}
environment: staging
runs-on: ubuntu-latest
Expand Down
Binary file modified bun.lockb
Binary file not shown.
42 changes: 21 additions & 21 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,38 +5,38 @@
"version": "0.0.0",
"license": "MIT",
"devDependencies": {
"@commitlint/cli": "^19.3.0",
"@commitlint/config-conventional": "^19.2.2",
"@types/bun": "^1.0.8",
"@vue/test-utils": "^2.4.5",
"cspell": "^8.13.0",
"eslint": "^8.52.0",
"husky": "^9.0.11",
"lint-staged": "^15.2.4",
"@commitlint/cli": "^19.4.1",
"@commitlint/config-conventional": "^19.4.1",
"@types/bun": "^1.1.8",
"@vue/test-utils": "^2.4.6",
"cspell": "^8.14.2",
"eslint": "^8.57.0",
"husky": "^9.1.5",
"lint-staged": "^15.2.10",
"markdownlint": "^0.33.0",
"markdownlint-cli2": "^0.12.1",
"nuxt": "^3.12.4",
"nuxt": "^3.13.1",
"particles.vue3": "^2.12.0",
"prettier": "^3.1.0",
"prettier-plugin-tailwindcss": "^0.5.12",
"prettier": "^3.3.3",
"prettier-plugin-tailwindcss": "^0.5.14",
"typescript": "^5.5.4",
"vue-tsc": "^2.0.6"
"vue-tsc": "^2.1.6"
},
"dependencies": {
"@matterlabs/docs-nuxt-template": "2.7.1",
"@matterlabs/docs-nuxt-template": "2.8.2",
"@nuxt/content": "^2.13.2",
"@nuxt/eslint": "^0.5.3",
"@nuxt/eslint": "^0.5.5",
"@nuxt/fonts": "^0.3.0",
"@nuxt/image": "^1.7.0",
"@nuxt/image": "^1.8.0",
"@nuxt/ui-pro": "^1.4.1",
"@nuxtjs/seo": "^2.0.0-rc.10",
"@tsparticles/slim": "^3.3.0",
"@nuxtjs/seo": "^2.0.0-rc.20",
"@tsparticles/slim": "^3.5.0",
"@tsparticles/vue3": "^3.0.1",
"@vite-pwa/nuxt": "^0.8.0",
"nuxt-gtag": "^2.0.6",
"@vite-pwa/nuxt": "^0.8.1",
"nuxt-gtag": "^2.1.0",
"nuxt-headlessui": "^1.2.0",
"nuxt-og-image": "^3.0.0-rc.45",
"rehype-katex": "^7.0.0",
"nuxt-og-image": "^3.0.0-rc.66",
"rehype-katex": "^7.0.1",
"remark-math": "^6.0.0",
"vue-easy-lightbox": "^1.19.0"
},
Expand Down
53 changes: 53 additions & 0 deletions renovate.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
{
"extends": [
"github>nuxt/renovate-config-nuxt",
"config:recommended",
"group:allNonMajor",
":semanticCommitTypeAll(chore)"
],
"timezone": "Europe/London",
"schedule": ["every weekend"],
"semanticCommits": "enabled",
"packageRules": [
{
"groupName": "Nuxt Dependencies",
"groupSlug": "template-deps",
"matchPackageNames": [
"@matterlabs/docs-nuxt-template",
"@iconify-json/**",
"@nuxt**",
"nuxt**",
"vue-easy-lightbox",
"@docsearch/**",
"rehype-katex",
"remark-math",
"dayjs"
]
},
{
"groupName": "ZK Dependencies",
"groupSlug": "zk-deps",
"matchPackageNames": ["ethers", "hardhat", "zksync-ethers"]
},
{
"groupName": "Tooling Dependencies",
"groupSlug": "tooling-deps",
"matchPackageNames": [
"eslint",
"@commitlint/**",
"cspell",
"husky",
"lint-staged",
"semantic-release",
"markdownlint**",
"prettier**",
"typescript",
"vue-tsc",
"@playwright/test",
"@vue/test-utils",
"node-pty",
"pm2"
]
}
]
}

0 comments on commit 7213406

Please sign in to comment.