Skip to content

Commit

Permalink
docs: set up vitepress github action and starter page
Browse files Browse the repository at this point in the history
  • Loading branch information
dairiley committed Nov 8, 2023
1 parent 4f1b0ba commit ff84b5b
Show file tree
Hide file tree
Showing 6 changed files with 1,485 additions and 109 deletions.
63 changes: 63 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Sample workflow for building and deploying a VitePress site to GitHub Pages
#
name: Deploy VitePress site to Pages

on:
# Runs on pushes targeting the `gh_pages` branch. Should be default branch
push:
branches: [gh-pages]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: pages
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0 # Not needed if lastUpdated is not enabled
- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: 18
cache: npm
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Install dependencies
run: npm ci
- name: Build with VitePress
run: |
npm run docs:build
touch docs/.vitepress/dist/.nojekyll
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: docs/.vitepress/dist

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: build
runs-on: ubuntu-latest
name: Deploy
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -440,4 +440,8 @@ venv

lib/user-interface/react-app/public/aws-exports.json
out.tmp
bin/config.json
bin/config.json

# Docs
docs/.vitepress/cache
docs/.vitepress/dist
15 changes: 15 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { defineConfig } from 'vitepress'

// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "AWS GenAI LLM Chatbot",
description: "Deploying a Multi-Model and Multi-RAG Powered Chatbot Using AWS CDK on AWS",
base: "/aws-genai-llm-chatbot/",
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: 'Home', link: '/' },
{ text: 'GitHub', link: 'https://github.com/aws-samples/aws-genai-llm-chatbot' }
],
}
})
12 changes: 12 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: home

hero:
name: "AWS GenAI LLM Chatbot"
text: "Deploying a Multi-Model and Multi-RAG Powered Chatbot Using AWS CDK on AWS"
actions:
- theme: brand
text: View on GitHub
link: https://github.com/aws-samples/aws-genai-llm-chatbot
---

Loading

0 comments on commit ff84b5b

Please sign in to comment.