Updated docs

This commit is contained in:
Amith Koujalgi 2023-12-26 14:30:25 +05:30
parent ba355d7f62
commit f128e708a0
3 changed files with 54 additions and 2 deletions

52
.github/workflows/publish-docs.yml vendored Normal file
View File

@ -0,0 +1,52 @@
# Simple workflow for deploying static content to GitHub Pages
name: Deploy Javadoc content to Pages
on:
# Runs on pushes targeting the default branch
push:
branches: [ "main" ]
# 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
packages: 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:
# Single deploy job since we're just deploying
deploy:
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/checkout@v4
- name: Use Node.js
uses: actions/setup-node@v3
with:
node-version: '20.x'
- run: cd docs && npm ci
- run: cd docs && npm run build
# - name: Build with npm
# run: npm i && npm run build
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
# Upload entire repository
path: './docs/build/.'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2

View File

@ -4,7 +4,7 @@ name: Deploy Javadoc content to Pages
on:
# Runs on pushes targeting the default branch
push:
branches: [ "main" ]
branches: [ "none" ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

View File

@ -79,7 +79,7 @@ const config = {
label: 'Tutorial',
},
{to: '/blog', label: 'Blog', position: 'left'},
{to: '/apidocs', label: 'Javadoc', position: 'left'},
{to: 'https://github.com/amithkoujalgi/ollama4j', label: 'Javadoc', position: 'left'},
{
href: 'https://github.com/amithkoujalgi/ollama4j',
label: 'GitHub',