Skip to content

add docs

add docs #1

Workflow file for this run

name: Deploy Documentation
on:
push:
branches:
- main
paths:
- 'mongodb-rag-docs/**'
- '.github/workflows/deploy-docs.yml'
permissions:
contents: write
jobs:
deploy:
name: Deploy to GitHub Pages
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 18
cache: npm
cache-dependency-path: mongodb-rag-docs/package-lock.json
- name: Install dependencies
working-directory: mongodb-rag-docs
run: npm ci
- name: Build website
working-directory: mongodb-rag-docs
run: npm run build
# Popular action to deploy to GitHub Pages:
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Build output to publish to the `gh-pages` branch:
publish_dir: ./mongodb-rag-docs/build
# Assign commit authorship to the official GH-Actions bot for deploys to `gh-pages` branch:
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com