switch to vitepress

Author: mozedz

.gitignore

@@ -1,8 +1,123 @@
-# Ignore compiled books
-book/
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
 
-# Ignoring .DS_Store
-.DS_Store
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 
-# Temp files
-*~
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+.env.production
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+docs/.vitepress/cache/
+docs/.vitepress/dist/
+.vitepress/cache/
+.v3-crawler.js

Dockerfile

@@ -1,21 +1,12 @@
-FROM rust:latest
+ARG NODE_VERSION=19
+FROM node:${NODE_VERSION}-alpine
 
-RUN cargo install mdbook
+WORKDIR /usr/src/app
 
-# We don't `COPY` the data into the image, because both for `build` and `serve`
-# it's useful to mount the data from the host at runtime.
+COPY package.json .
+RUN npm install
 
-# We don't predefine a `WORKDIR` for flexibility to use the kagi or orion Knowledgebase Maps.
+COPY . .
 
-VOLUME /kagi-docs
-
-EXPOSE 3000
-
-ENTRYPOINT ["mdbook"]
-
-# This serves on 0.0.0.0:3000 by default, suitable for running in a standard Docker network.
-# This way the server is reachable from the host via `localhost:3000` when you start the container with `docker run -p 127.0.0.1:3000:3000 ...`.
-#
-# Alternatively, when you want to run the container in the host network, you might not want to expose the server to other hosts.
-# Then you run with `docker run ... --network host <image> serve -n localhost`.
-CMD ["serve", "-n", "0.0.0.0"]
+RUN npm run docs:build
+ENTRYPOINT npm run docs:preview

README.md

@@ -23,7 +23,7 @@ Product | Documentation         | Repo Directory
 [Kagi Search](https://kagi.com) | https://help.kagi.com/kagi | [kagi](https://github.com/kagisearch/kagi-docs/tree/main/kagi)
 [Orion Browser](https://browser.kagi.com) | https://help.kagi.com/orion | [orion](https://github.com/kagisearch/kagi-docs/tree/main/orion)
 
-Our documentation efforts are ongoing! We welcome your feedback and 
+Our documentation efforts are ongoing! We welcome your feedback and
 contributions - read on for details!
 
 ## Support
@@ -106,33 +106,12 @@ first, and we will help guide you along!
 A template in the pull request form will guide you in providing any additional
 details we need to help accept your changes.
 
-## Building
-
-All documentation is written to be hosted with the open-source
-[mdBook](https://rust-lang.github.io/mdBook/) documentation utility.
-
-Each directory in the [Knowledgebase Map](#knowledgebase-map) is built as its
-own book, configured for that products own criteria, look, and feel.
-
-To get started:
 
-1. Install [mdBook](https://rust-lang.github.io/mdBook/guide/installation.html)
-2. Navigate to the book you wish to build in the [Knowledgebase Map](#knowledgebase-map)
-3. Run `mdbook build` in that directory to compile the book to a `book/`
-   directory with the rendered contents. You can open `book/index.html` to start browsing.
-
-You can also run `mdbook serve` and open [http://localhost:3000](http://localhost:3000)
-to view the documentation in your browser. mdBook will watch your files and automatically
-rebuild & refresh the page when the book's files are updated.
-
-See each book's `book.toml` for configuration options we have applied.
+## Building
 
-### With Docker
+Kagi's docs generated by [Vitepress](https://vitepress.dev/).
 
-If you don't have and don't want to install Rust on your local machine, you can use Docker instead. The command examples assume you're in the root of the Git repository.
+### Development on your localhost
 
-1. Build the image `docker build -t kagi-docs .`
-2. Run the container to build or serve:
-   - Build example: `docker run --rm -v /path/to/kagi-docs:/kagi-docs --workdir /kagi-docs/kagi kagi-docs build`.
-   - Serve example: `docker run -it --rm -v /path/to/kagi-docs:/kagi-docs --workdir /kagi-docs/kagi -p 127.0.0.1:3000:3000 kagi-docs`.
-     - If mdBooks doesn't stop on Ctrl+C, you can detach with Ctrl+P Ctrl+Q and then run `docker stop <container_name>`
+    npm install
+    npm run docs:dev

cloudbuild.yaml

@@ -0,0 +1,46 @@
+steps:
+  - name: 'node:19'
+    entrypoint: 'npm'
+    args: ['install']
+  - name: 'node:19'
+    entrypoint: 'npm'
+    args:
+      - 'run'
+      - 'docs:build'
+  - name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
+    entrypoint: 'gsutil'
+    args:
+      - '-m'
+      - 'rsync'
+      - '-r'
+      - '-d'
+      - 'docs/.vitepress/dist/'
+      - 'gs://kagi-us-east1-docs-vitepress/'
+  - name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
+    entrypoint: 'gcloud'
+    args:
+      - 'compute'
+      - 'url-maps'
+      - 'invalidate-cdn-cache'
+      - 'kagi-prod-urlmap-anycast'
+      - '--path'
+      - '/*'
+      - '--host'
+      - 'docs.kagi.com'
+      - '--project'
+      - 'kagi-global'
+  - name: 'gcr.io/cloud-builders/docker'
+    entrypoint: 'bash'
+    args:
+      - '-c'
+      - |-
+          apt-get -y update && \
+            apt-get install jq -y
+          echo APPLICATION_ID=KX359CJ2OY > .env
+          echo API_KEY=$$API_KEY >> .env
+          docker run --env-file=.env -e "CONFIG=$(cat scrape-config.json | jq -r tostring)" algolia/docsearch-scraper@sha256:7bc1cd5aa4783bf24be9ddd6ef22a629b6b43e217b3fa220b6a0acbdeb83b8f8
+    secretEnv: ['API_KEY']
+availableSecrets:
+  secretManager:
+  - versionName: projects/$PROJECT_ID/secrets/kagi-docs-write-api-key/versions/latest
+    env: 'API_KEY'