Skip to content

Add documentation for VortexDB #1

Add documentation for VortexDB

Add documentation for VortexDB #1

Workflow file for this run

name: Deploy Docs
on:
push:
branches:
- refactor
paths:
- 'docs/**'
pull_request:
branches:
- refactor
paths:
- 'docs/**'
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
name: Build Docs
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
- name: Install Mintlify CLI
run: npm install -g mintlify
- name: Export Docs
working-directory: docs
run: mintlify export
- name: Unzip Export
working-directory: docs
run: unzip export.zip -d site
- name: Add SPA fallback
run: |
cp docs/site/index.html docs/site/404.html
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/site
deploy:
name: Deploy to GitHub Pages
if: github.event_name == 'push'
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4