Merge pull request #2 from theam/add_gh_pages

publish docs

.github/workflows/wf_build-docs.yml

@@ -0,0 +1,28 @@
+name: Build documentation (no publish)
+
+on:
+ pull_request:
+ branches:
+ - main
+ workflow_dispatch:
+
+jobs:
+ deploy-docs:
+ name: Build documentation (no publish)
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ - uses: actions/setup-node@v3
+ with:
+ path: docs-site
+ node-version: 18
+ cache: npm
+ cache-dependency-path: docs-site/package-lock.json
+
+ - name: Install dependencies
+ run: npm ci
+ working-directory: docs-site
+
+ - name: Build website
+ run: npm run build
+ working-directory: docs-site

.github/workflows/wf_publish-docs.yml

@@ -0,0 +1,39 @@
+name: Publish documentation
+
+on:
+ push:
+ branches:
+ - main
+ workflow_dispatch:
+
+jobs:
+ deploy-docs:
+ name: Publish documentation
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ - uses: actions/setup-node@v3
+ with:
+ path: docs-site
+ node-version: 18
+ cache: npm
+ cache-dependency-path: docs-site/package-lock.json
+
+ - name: Install dependencies
+ run: npm ci
+ working-directory: docs-site
+
+ - name: Build website
+ run: npm run build
+ working-directory: docs-site
+
+ # 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: ./docs-site/build
+ user_name: github-actions[bot]
+ user_email: 41898282+github-actions[bot]@users.noreply.github.com

docs-site/docs/01_introduction.md

@@ -5,7 +5,7 @@ slug: /
 
 eLLMental is the ultimate library of components for building LLM-driven projects in the JVM.
 
-Wanna try? Go straight to the [Getting Started Guide](/docs/02_getting_started.md), or keep reading to know more about eLLMental.
+Wanna try? Go straight to the [Getting Started Guide](02_getting_started.md), or keep reading to know more about eLLMental.
 
 ## What can you do with eLLMental?
 

docs-site/docs/02_getting_started.md

@@ -0,0 +1,5 @@
+---
+slug: /getting-started
+---
+
+# Getting started

docs-site/static/CNAME

@@ -0,0 +1 @@
+docs.ellmental.com