Skip to content

Commit 3af809c

Browse files
committed
Configure documentation deployment
1 parent 4f0e410 commit 3af809c

File tree

2 files changed

+113
-0
lines changed

2 files changed

+113
-0
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- 'mongodb-rag-docs/**'
9+
- '.github/workflows/deploy-docs.yml'
10+
11+
permissions:
12+
contents: write
13+
14+
jobs:
15+
deploy:
16+
name: Deploy to GitHub Pages
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@v3
20+
- uses: actions/setup-node@v3
21+
with:
22+
node-version: 18
23+
cache: npm
24+
cache-dependency-path: mongodb-rag-docs/package-lock.json
25+
26+
- name: Install dependencies
27+
working-directory: mongodb-rag-docs
28+
run: npm ci
29+
30+
- name: Build website
31+
working-directory: mongodb-rag-docs
32+
run: npm run build
33+
34+
# Popular action to deploy to GitHub Pages:
35+
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
36+
- name: Deploy to GitHub Pages
37+
uses: peaceiris/actions-gh-pages@v3
38+
with:
39+
github_token: ${{ secrets.GITHUB_TOKEN }}
40+
# Build output to publish to the `gh-pages` branch:
41+
publish_dir: ./mongodb-rag-docs/build
42+
# Assign commit authorship to the official GH-Actions bot for deploys to `gh-pages` branch:
43+
user_name: github-actions[bot]
44+
user_email: 41898282+github-actions[bot]@users.noreply.github.com
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
const config = {
2+
title: 'MongoDB-RAG',
3+
tagline: 'Retrieval-Augmented Generation with MongoDB',
4+
url: 'https://mongodb-developer.github.io',
5+
baseUrl: '/mongodb-rag/',
6+
organizationName: 'mongodb-developer',
7+
projectName: 'mongodb-rag',
8+
trailingSlash: false,
9+
10+
presets: [
11+
[
12+
'@docusaurus/preset-classic',
13+
{
14+
docs: {
15+
sidebarPath: require.resolve('./sidebars.js'),
16+
editUrl: 'https://github.com/mongodb-developer/mongodb-rag/tree/main/mongodb-rag-docs/',
17+
},
18+
theme: {
19+
customCss: require.resolve('./src/css/custom.css'),
20+
},
21+
},
22+
],
23+
],
24+
25+
themeConfig: {
26+
navbar: {
27+
title: 'MongoDB-RAG',
28+
items: [
29+
{
30+
type: 'docSidebar',
31+
sidebarId: 'docs',
32+
position: 'left',
33+
label: 'Docs',
34+
},
35+
{
36+
href: 'https://github.com/mongodb-developer/mongodb-rag',
37+
label: 'GitHub',
38+
position: 'right',
39+
},
40+
],
41+
},
42+
footer: {
43+
style: 'dark',
44+
links: [
45+
{
46+
title: 'Documentation',
47+
items: [
48+
{
49+
label: 'Documentation',
50+
to: '/docs/intro',
51+
},
52+
],
53+
},
54+
{
55+
title: 'More',
56+
items: [
57+
{
58+
label: 'GitHub',
59+
href: 'https://github.com/mongodb-developer/mongodb-rag',
60+
},
61+
],
62+
},
63+
],
64+
copyright: `Copyright © ${new Date().getFullYear()} MongoDB. Built with Docusaurus.`,
65+
},
66+
},
67+
};
68+
69+
module.exports = config;

0 commit comments

Comments
 (0)